API REST

API REST : votre catalogue Upsellr, piloté depuis vos propres outils.

Créez des produits depuis votre ERP, envoyez vos fichiers fournisseurs, lancez l’enrichissement et la génération, puis lisez les contenus rédigés pour chaque canal et chaque langue. Une API REST documentée, avec des clés aux droits limités.

Catégorie
API
Sens
Lecture et écriture
Version
REST v2, spécification OpenAPI
Clés
Jusqu’à 10 par organisation, droits au choix
Langues
Libellés en français, anglais, espagnol et allemand
Authentification
Clé d’API dans l’en-tête Authorization
Offres
Offre Enterprise
Éditeur
Upsellr

01Ce que fait l’API

Upsellr, depuis vos propres outils.

  1. 01

    Créez vos produits par lots

    Envoyez jusqu’à 100 produits par appel. Upsellr les reconnaît par EAN, SKU ou référence fabricant et marque : un produit déjà connu n’est pas dupliqué, il reçoit une nouvelle version si une valeur change.

  2. 02

    Lisez votre master data

    Champs, listes de valeurs, catégories et modèles : ce qui structure votre catalogue se lit par l’API, avec les libellés dans votre langue.

  3. 03

    Envoyez vos fichiers fournisseurs

    Déposez vos tableurs et vos PDF dans la bibliothèque de fichiers d’Upsellr : jusqu’à 10 Mio en un envoi, au-delà en plusieurs parties.

  4. 04

    Lancez l’enrichissement et la génération

    Démarrez un traitement sur une sélection, une recherche ou tout le catalogue, jusqu’à 50 000 produits : Lily enrichit la master data, Max rédige les fiches de vos canaux, ou l’un de vos workflows s’exécute.

  5. 05

    Lisez les contenus générés

    Chaque produit renvoie sa master data, ses valeurs importées et ses contenus générés, rangés par canal et par langue.

  6. 06

    Suivez vos traitements

    Un traitement se suit par l’API, ou par webhook : terminé, en échec ou arrêté, votre outil est prévenu.

02Mise en route

Votre première requête en quelques minutes.

  1. 01

    Ouvrez les paramètres de l’organisation

    Section API et webhooks, réservée aux propriétaires et aux administrateurs.

  2. 02

    Créez une clé

    Choisissez ses droits : lecture seule, lecture et écriture, ou accès complet. Ajoutez une date d’expiration et des adresses IP autorisées si vous le souhaitez.

  3. 03

    Branchez-la dans votre outil

    Elle s’envoie dans l’en-tête Authorization de chaque appel.

  4. 04

    Appelez l’API depuis votre serveur

    Elle ne s’appelle pas depuis un navigateur : vos clés restent côté serveur.

  5. 05

    Suivez vos traitements

    Par l’API, ou avec un webhook qui vous prévient à la fin de chaque traitement.

03Ressources

Ce que l’API permet de lire et d’écrire.

RessourceLectureÉcriture
ProduitsOuiOui
EAN, SKU et référence fabricantOuiOui
Valeurs de la master dataOuiOui
Contenus générés, par canal et par langueOuiNon
Champs et listes de la master dataOuiNon
Fichiers sourcesOuiOuiJusqu’à 10 Mio, ou en plusieurs parties
Traitements d’enrichissement et de générationOuiOui
Prix

Compatibilité et prérequis

  • L’offre Enterprise
  • Un rôle propriétaire ou administrateur pour créer les clés
  • Un serveur pour appeler l’API, jamais un navigateur
  • L’en-tête Authorization: Bearer sur chaque appel
  • Conseil : une clé par outil, avec les seuls droits utiles

Vous gardez la main

Des clés sous contrôle.

  • Des droits par clé : lecture seule, lecture et écriture, ou accès complet
  • Une date d’expiration et des adresses IP autorisées, si vous le souhaitez
  • Des limites d’appels par organisation, signalées en cas de dépassement
  • Un identifiant de requête dans chaque réponse, pour le support

04Questions

Questions sur l’API Upsellr.

L’API est-elle incluse dans mon offre ?

Elle est réservée à l’offre Enterprise. Sur les autres offres, la section API et webhooks est visible mais verrouillée.

Où trouver la documentation ?

La référence de l’API est générée depuis sa spécification OpenAPI, avec des exemples en curl, JavaScript, Python et Ruby.

Quelles sont les limites d’appels ?

Par organisation : 200 lectures et 60 écritures par minute, et 20 par minute pour les opérations lourdes, comme la création de produits, l’envoi de fichiers et le lancement de traitements. Au-delà, l’API répond 429 avec le délai à attendre.

Puis-je modifier ou supprimer un produit par l’API ?

Pas encore. Vous créez des produits, et renvoyer un produit existant lui donne une nouvelle version si une valeur change. La modification et la suppression se font dans Upsellr.

Comment éviter les doublons ?

Upsellr reconnaît chaque produit par son EAN, son SKU, ou sa référence fabricant et sa marque : renvoyer le même produit ne le duplique pas.

Puis-je lancer l’enrichissement depuis mon outil ?

Oui. Lancez l’enrichissement, la génération, les deux, ou l’un de vos workflows, sur une sélection, une recherche ou tout le catalogue, jusqu’à 50 000 produits par traitement.

Comment savoir qu’un traitement est terminé ?

Interrogez le traitement par l’API, ou recevez un webhook quand il se termine, échoue ou est arrêté.

Existe-t-il un SDK ?

Pas pour l’instant : l’API est une API REST classique, et la référence donne des exemples prêts à copier.

Votre prochain produit
mérite mieux qu’un copier-coller.

Confiez ses premiers produits à votre équipe IA.