REST API
REST API: uw Upsellr-catalogus, aangestuurd vanuit uw eigen tools.
Maak producten aan vanuit uw ERP, upload uw leveranciersbestanden, start verrijking en generatie en lees daarna de content die voor elk kanaal en elke taal is geschreven. Een gedocumenteerde REST API, met sleutels met beperkte rechten.
- Categorie
- API
- Richting
- Lezen en schrijven
- Versie
- REST v2, OpenAPI-specificatie
- Sleutels
- Tot 10 per organisatie, rechten naar keuze
- Talen
- Labels in het Frans, Engels, Spaans en Duits
- Authenticatie
- API-sleutel in de Authorization-header
- Abonnementen
- Enterprise-abonnement
- Uitgever
- Upsellr
01Wat de API doet
Upsellr, vanuit uw eigen tools.
- 01
Maak uw producten in batches aan
Verstuur tot 100 producten per aanroep. Upsellr herkent ze aan EAN, SKU of fabrikantreferentie en merk: een bekend product wordt niet gedupliceerd, maar krijgt een nieuwe versie als een waarde verandert.
- 02
Lees uw master data
Velden, waardelijsten, categorieën en sjablonen: wat uw catalogus structureert, leest u via de API, met labels in uw taal.
- 03
Upload uw leveranciersbestanden
Plaats uw spreadsheets en pdf’s in de bestandsbibliotheek van Upsellr: tot 10 MiB in één upload, daarboven in meerdere delen.
- 04
Start verrijking en generatie
Start een verwerking op een selectie, een zoekopdracht of de hele catalogus, tot 50.000 producten: Lily verrijkt de master data, Max schrijft de pagina’s van uw kanalen, of een van uw workflows wordt uitgevoerd.
- 05
Lees de gegenereerde content
Elk product geeft zijn master data, zijn geïmporteerde waarden en zijn gegenereerde content terug, geordend per kanaal en per taal.
- 06
Volg uw verwerkingen
Een verwerking volgt u via de API of via een webhook: voltooid, mislukt of gestopt, uw tool krijgt een melding.
02Aan de slag
Uw eerste request binnen enkele minuten.
- 01
Open de organisatie-instellingen
Sectie API en webhooks, voorbehouden aan eigenaren en beheerders.
- 02
Maak een sleutel aan
Kies de rechten: alleen lezen, lezen en schrijven, of volledige toegang. Voeg desgewenst een vervaldatum en toegestane IP-adressen toe.
- 03
Koppel hem aan uw tool
Hij wordt bij elke aanroep meegestuurd in de Authorization-header.
- 04
Roep de API aan vanaf uw server
Niet vanuit een browser: uw sleutels blijven aan de serverkant.
- 05
Volg uw verwerkingen
Via de API, of met een webhook die u aan het einde van elke verwerking een melding stuurt.
03Resources
Wat de API kan lezen en schrijven.
| Resource | Lezen | Schrijven |
|---|---|---|
| Producten | Ja | Ja |
| EAN, SKU en fabrikantreferentie | Ja | Ja |
| Waarden van de master data | Ja | Ja |
| Gegenereerde content, per kanaal en per taal | Ja | Nee |
| Velden en lijsten van de master data | Ja | Nee |
| Bronbestanden | Ja | JaTot 10 MiB, of in meerdere delen |
| Verrijkings- en generatieverwerkingen | Ja | Ja |
| Prijs |
Compatibiliteit en vereisten
- Het Enterprise-abonnement
- Een rol als eigenaar of beheerder om sleutels aan te maken
- Een server om de API aan te roepen, nooit een browser
- De header Authorization: Bearer bij elke aanroep
- Tip: één sleutel per tool, met alleen de rechten die nodig zijn
U houdt de regie
Sleutels onder controle.
- Rechten per sleutel: alleen lezen, lezen en schrijven, of volledige toegang
- Een vervaldatum en toegestane IP-adressen, als u dat wilt
- Aanroeplimieten per organisatie, met een melding bij overschrijding
- Een request-ID in elk antwoord, voor de support
04Vragen
Vragen over de Upsellr API.
Zit de API in mijn abonnement?
De API is voorbehouden aan het Enterprise-abonnement. Bij de andere abonnementen is de sectie API en webhooks zichtbaar maar vergrendeld.
Waar vind ik de documentatie?
De API-referentie wordt gegenereerd uit de OpenAPI-specificatie, met voorbeelden in curl, JavaScript, Python en Ruby.
Wat zijn de aanroeplimieten?
Per organisatie: 200 leesacties en 60 schrijfacties per minuut, en 20 per minuut voor zware bewerkingen, zoals producten aanmaken, bestanden uploaden en verwerkingen starten. Daarboven antwoordt de API met 429 en de wachttijd.
Kan ik een product via de API wijzigen of verwijderen?
Nog niet. U maakt producten aan, en een bestaand product opnieuw versturen geeft het een nieuwe versie als een waarde verandert. Wijzigen en verwijderen doet u in Upsellr.
Hoe voorkom ik duplicaten?
Upsellr herkent elk product aan zijn EAN, zijn SKU, of zijn fabrikantreferentie en merk: hetzelfde product opnieuw versturen dupliceert het niet.
Kan ik de verrijking vanuit mijn tool starten?
Ja. Start de verrijking, de generatie, beide, of een van uw workflows, op een selectie, een zoekopdracht of de hele catalogus, tot 50.000 producten per verwerking.
Hoe weet ik dat een verwerking klaar is?
Vraag de verwerking op via de API, of ontvang een webhook wanneer ze voltooid is, mislukt of wordt gestopt.
Is er een SDK?
Voorlopig niet: de API is een gewone REST API, en de referentie bevat voorbeelden die u direct kunt kopiëren.
Je volgende product
verdient meer dan knippen en plakken.
Geef je AI-team zijn eerste producten om mee aan de slag te gaan.
Marcus
Amazon