DéveloppeursVue d’ensemble de l’API

Vue d'ensemble de l'API

La forme de la surface API de BoostEcom : ce qui est public, ce qui est authentifié, et quelle porte prendre pour quel usage.

La plateforme expose 455 gestionnaires de routes sous /api. Ce chiffre est dérivé du dépôt au moment du build, pas tenu à la main : s'il est faux ici, le build échoue.

La plupart servent le tableau de bord en interne. Ce qui suit, c'est la partie sur laquelle vous pouvez vous brancher.

Trois portes, trois usages

PortePourAuth
Serveur MCP distantDonner à un client IA l'accès aux outils d'une boutique.OAuth 2.1 PKCE, ou un bearer bst_mcp_.
Intelligence APILire des fiches Store Intelligence depuis un programme.Clé bei_, lecture seule.
WebhooksRecevoir des événements de Stripe, Shopify et Resend.Vérification de signature, propre à chaque fournisseur.

Choisissez selon ce que vous construisez. Un client IA qui doit agir sur une boutique passe par le serveur MCP. Un script qui doit lire de l'intelligence passe par l'Intelligence API. Il n'existe pas d'API REST généraliste pour modifier une boutique : cette surface, c'est le serveur MCP, volontairement, parce que chacun de ses outils vérifie un scope.

Versionnage : à lire avant de construire

Soyons précis, puisque cette page ne l'était pas auparavant :

  • Il n'y a pas d'en-tête de version d'API. Rien dans la plateforme n'en lit. N'en envoyez pas, et ne construisez rien autour.
  • L'endpoint MCP a deux chemins. L'original, /api/mcp/<storeId>, a été livré sans version et les clients installés l'ont dans leur configuration : il reste donc exactement tel quel, sans limite de durée. Les nouvelles connexions doivent utiliser /api/mcp/v1/<storeId>.
  • Ces deux chemins sont un seul endpoint sous deux noms : les mêmes gestionnaires, et un token émis par l'un ou l'autre fonctionne sur les deux.
  • Aucune période de dépréciation n'est publiée, parce que rien n'a encore été déprécié. Le jour où ce sera le cas, la politique sera écrite ici avant la dépréciation, pas après.

Limites de débit

Les limites sont comptées par identifiant plutôt que par adresse IP. C'est important si vous appelez depuis une plateforme serverless, où l'adresse change d'une invocation à l'autre.

Erreurs

CodeSignification
401Identifiant absent, mal formé ou révoqué.
402Le coût estimé dépasse le solde de crédits de l'organisation.
403Authentifié, mais le scope, l'appartenance ou le rôle ne le permet pas.
404Aucune ressource ne porte cet identifiant dans un tenant qui vous est accessible.

Lequel des deux vous recevez, et dans quel ordre, est détaillé dans Erreurs et limites de débit.

Ensuite