fofodéveloppeurs

Authentification

Clés API, droits et limites d’appels.

Chaque appel porte une clé API dans l’en-tête Authorization :

Authorization: Bearer fx_live_…

Créer et gérer les clés

Seul le propriétaire de la boutique crée et révoque les clés. Une boutique peut en avoir plusieurs, une par site ou par logiciel, dans la limite fixée par Fofo Express.

  • La clé n’est affichée qu’à sa création. Fofo Express n’en garde qu’une empreinte : une clé perdue se remplace, elle ne se retrouve pas.
  • Chaque clé a un nom, un début reconnaissable (fx_live_abc123) et une date de dernière utilisation.
  • Une clé révoquée est refusée immédiatement.
  • L’API agit au nom du membre qui a créé la clé. S’il quitte la boutique, ses clés cessent de fonctionner.

Droits

DroitPermet
quotes:readPrix d’une course (POST /quotes), zones desservies (GET /zones).
deliveries:readAdresses d’enlèvement, liste, détail et historique des livraisons.
deliveries:writeCréation et annulation des livraisons.

Donnez à chaque clé le minimum nécessaire : une clé de tableau de bord n’a besoin que de deliveries:read.

Limite d’appels

Chaque clé dispose d’un nombre d’appels par minute (60 par défaut). Au-delà, l’API répond 429 avec le code RATE_LIMITED et l’en-tête Retry-After, en secondes. Attendez ce délai avant de réessayer.

Ne mettez jamais une clé API dans une application mobile ou du JavaScript exécuté dans le navigateur : appelez l’API depuis votre serveur.

Sur cette page