Passer au contenu principal
La plupart des API Plato utilisent des clés API créées dans la console. Créez des clés à partir de Clés de la console API. Utilisez une clé dédiée par intégration afin qu’elle puisse être pivotée ou supprimée sans affecter les autres outils.

​
En-tête préféré

Pour la plupart des requêtes API, envoyez la clé sous forme de jeton Bearer : 
Authorization: Bearer plato_your_api_key
Exemple: 
curl "https://api.plato.ae/api/public/cms/products/list" \
  -H "Authorization: Bearer $PLATO_API_KEY"

​
En-tête alternatif

Certaines intégrations utilisent x-api-key : 
x-api-key: plato_your_api_key
Exemple: 
curl "https://api.plato.ae/api/public/cms/products/list" \
  -H "x-api-key: $PLATO_API_KEY"

​
Paramètre de requête

Les anciens points de terminaison REST acceptent également apiKey dans la chaîne de requête : 
curl "https://api.plato.ae/api/public/menu/products?apiKey=$PLATO_API_KEY"
Utilisez les en-têtes pour les nouvelles intégrations côté serveur. Les chaînes de requête peuvent apparaître dans les journaux, l’historique du navigateur, les outils d’analyse et les URL partagées.

​
Authentification SDK

Le Plato SDK envoie l’en-tête Bearer pour vous. 
import { createPlatoApiClient } from "plato-api-sdk";

const plato = createPlatoApiClient({
  baseUrl: "https://api.plato.ae",
  apiKey: process.env.PLATO_API_KEY,
});
Gardez PLATO_API_KEY sur le serveur. Ne l’exposez pas dans le navigateur JavaScript ou dans les applications mobiles.

​
Authentification de session

Le point de terminaison du profil utilise la session utilisateur connectée au lieu d’une clé API. Utilisez des points de terminaison basés sur une session uniquement lorsque la demande est effectuée pour un utilisateur connecté. Les intégrations de clé API doivent utiliser les routes de clé API documentées dans cette section.

​
Sécurité clé

  • Stockez les clés API dans des variables d’environnement ou dans un gestionnaire de secrets.
  • Ne collez pas les clés dans du code public, des captures d’écran, des tickets d’assistance ou des documents.
  • Faites pivoter les clés lorsqu’un propriétaire d’outil change.
  • Supprimez les clés qui ne sont plus utilisées.
  • Donnez à chaque clé le plus petit rôle qui permet encore à l’intégration de fonctionner.