Aller au contenu

Développeurs

Clés, portéeset limites

Le fonctionnement de l’authentification, le périmètre de l’API, ses limites de débit et la façon d’obtenir une clé pour votre boutique.

Authentification

Un jeton Bearer, rattaché à une seule boutique

Les clés sont émises par boutique et portent des portées explicites. Une clé peut lire les produits sans pouvoir effectuer de remboursements : c’est toute la différence entre brancher un flux de stock et confier les clés de l’entreprise.

  • Jetons Bearer dans l’en-tête Authorization
  • Portées par ressource, lecture et écriture séparées
  • Clés révocables à tout moment depuis le tableau de bord
  • Chaque appel est tracé dans le journal d’audit de la boutique
http
POST /v1/orders/{id}/fulfilments
Authorization: Bearer sk_live_…
Content-Type: application/json

{
  "outletId": "out_3f9",
  "lines": [{ "orderLineId": "ol_88", "quantity": 2 }],
  "deliveryMethod": "RIDER"
}

Référence

Ce que vous pouvez appeler

Les groupes de ressources disponibles aujourd’hui. Les schémas complets de requête et de réponse seront publiés avec la référence publique.

RessourceCheminOpérations
Produits/v1/productslister · créer · modifier · supprimer
Variantes/v1/products/{id}/variantslister · créer · modifier
Collections/v1/collectionslister · créer · modifier
Stock/v1/inventory/levelslister · ajuster · transférer
Commandes/v1/orderslister · créer · modifier · annuler
Expéditions/v1/orders/{id}/fulfilmentslister · créer
Retours/v1/returnslister · créer · approuver
Clients/v1/customerslister · créer · modifier
Paiements/v1/paymentslister · rembourser
Factures/v1/invoiceslister · créer · envoyer
Points de vente/v1/outletslist
Webhooks/v1/webhookslister · créer · supprimer

Limites et comportement

Ce à quoi s’attendre côté réseau

Limitation de débit

Limites par clé, avec le quota restant renvoyé dans chaque réponse. Une requête limitée renvoie une erreur 429 avec un délai conseillé, plutôt que d’échouer en silence.

Pagination

Les listes sont paginées par curseur. Parcourez-les avec le curseur de la réponse précédente plutôt que de récupérer les enregistrements un par un.

Idempotence

Les requêtes d’écriture acceptent une clé d’idempotence : une nouvelle tentative après un délai d’attente ne créera ni deuxième commande ni deuxième remboursement.

Erreurs

Les échecs renvoient un code stable et lisible par une machine en plus du message, pour que votre intégration s’appuie sur le code plutôt que sur la formulation.

Versionnage

La version figure dans le chemin. Les changements incompatibles sortent dans une nouvelle version ; les ajouts arrivent sur place et sont annoncés à l’avance.

Envoi des webhooks

Les charges utiles sont signées et renvoyées avec un délai progressif. Les envois et leurs réponses sont consultables, ce qui permet de diagnostiquer un endpoint défaillant.

Dites-nous ce que vous développez