Utiliser l'API publique

Adresse de base, authentification, limites de débit et identifiant de requête : l'essentiel pour brancher vos outils sur Upsellr.

L’API publique d’Upsellr donne accès à votre master data, à vos produits, à vos sources et à vos workflows depuis vos propres outils. Elle est incluse dans l’offre Enterprise.

L’essentiel

  • Adresse de base : https://api.upsellr.io/v2
  • Authentification : chaque requête porte l’en-tête Authorization avec la valeur Bearer suivie de votre clé. Voir créer et gérer des clés API.
  • Documentation : la référence complète, avec des exemples, est publiée sur docs.upsellr.io.

Appels depuis un serveur uniquement

L’API s’appelle depuis un serveur, jamais depuis un navigateur : elle ne répond pas aux requêtes envoyées par une page web. Cela évite aussi d’exposer votre clé dans le code d’une page.

Les limites de débit

Les limites s’appliquent à l’organisation entière, toutes clés confondues.

Type de requête Par minute Rafale
Lectures 200 30
Écritures 60 10
Écritures lourdes : création de produits, dépôt de fichier, lancement de workflow 20 5
Recherche et lecture de produits 60 5

Au-delà, l’API répond avec le code 429 et un en-tête Retry-After qui indique, en secondes, quand réessayer.

Identifiant de requête

Chaque réponse porte un en-tête X-Request-Id. Si une requête échoue de façon inattendue, notez cet identifiant et transmettez-le au support : il permet de retrouver exactement votre appel.

Bon à savoir

  • Une clé limitée à certaines adresses IP ou certains User-Agents est refusée depuis toute autre origine.
  • Trop de requêtes avec une clé invalide depuis une même adresse entraînent un blocage temporaire, signalé par un code 429.
  • Une clé n’agit que dans les limites de ses portées : une requête hors portée est refusée.
  • Lancer un workflow par l’API consomme des crédits comme depuis l’application.
  • Pour être prévenu de la fin d’une exécution sans interroger l’API en boucle, utilisez les webhooks.
  • Une question ? Passez par nous contacter ou le bouton Signaler un bug dans l’app, avec l’identifiant de requête.

Vous ne trouvez pas la réponse ?

Nous contacter