Passer au contenu principal
Les API Plato permettent à des outils fiables de se connecter à votre espace de travail Plato. Utilisez-les lorsque vous devez synchroniser les données de menu, soumettre des réponses à un formulaire, lire ou écrire des entrées CMS, connecter une expérience de chat sur un site Web ou extraire des données de commande de restaurant dans un autre système.

Familles API

Plato propose deux styles API destinés aux clients.

URL de base

Choisissez le bon hôte API pour la production, la configuration de la console, les environnements privés et le développement local.

Authentification

Envoyez les clés Plato API en toute sécurité avec des en-têtes et gardez les clés hors du code public.

Autorisations

Mappez les clés API aux rôles afin que chaque intégration ne puisse accéder qu’à ce dont elle a besoin.

Erreurs et limites

Gérez les erreurs courantes, les limites de pagination, les limites de débit et les tentatives sécurisées.

API de données et de flux de travail

CMS API

Lisez et écrivez des entrées CMS structurées à partir de sites Web, d’applications et de backends fiables.

Connect360 API

Créez des flux de chat, de conversation, de pièces jointes et de messagerie assistés par AI sur un site Web.

API de restauration

Lisez les produits de menu, les catégories et les données de flux de commandes récentes.

Formulaires API

Récupérez les schémas de formulaires publics et soumettez des réponses de formulaire fiables.

Backend typé API

Les appels backend typés sont utilisés pour certaines intégrations côté serveur. Utilisez-le pour :
  • Conversations, messages, pièces jointes et réponses AI Connect360.
  • Accès au flux de commandes du restaurant.
  • Formes de requête et de réponse saisies générées à partir de Plato.
Les requêtes SDK transitent par :
https://api.plato.ae/api/trpc
La barre latérale publique se concentre d’abord sur les familles stables API. Utilisez la page familiale API appropriée pour décider quel itinéraire appeler.

API publiques REST

Les API publiques REST sont meilleures lorsqu’un site Web, un outil sans code ou un backend non TypeScript a besoin de points de terminaison HTTP simples. Utilisez-les pour :
  • Entrées CMS.
  • Produits et catégories de menu.
  • Formulaires publics.
  • Modèles dynamiques hérités.
Les requêtes REST transitent par :
https://api.plato.ae
Commencez par Authentification, puis ouvrez la famille API dont vous avez besoin.

Ce qui n’est pas un API public

Certaines routes existent pour que Plato puisse exécuter la console, traiter des webhooks, restituer des PDF ou authentifier les utilisateurs. Ces itinéraires ne constituent pas des contrats publics d’intégration stables. Ne créez pas d’intégrations externes sur des routes telles que des rappels d’authentification, des webhooks Stripe ou du fournisseur, des tâches cron, des images Open Graph ou des requêtes internes du navigateur de la console. Voir Itinéraires internes pour la courte liste des itinéraires à éviter.

Avant de construire

  1. Créez un rôle dédié pour l’intégration.
  2. Donnez à ce rôle uniquement les autorisations dont il a besoin.
  3. Créez une clé API dans la console.
  4. Stockez la clé dans un magasin secret côté serveur.
  5. Testez avec une petite requête avant d’envoyer le trafic de production.
Créez des clés à partir de Clés de la console API.