Ontwikkelaars

De openbare API van ControlResell

Automatiseer uw bedrijf met uw eigen scripts en tools: lees uw accounts, artikelen en gesprekken met een API-sleutel.

De openbare API wordt geleidelijk uitgerold. Ze is voorbehouden aan abonnementen die ze bevatten en wordt stapsgewijs geopend: de pagina voor sleutelbeheer is nog niet op elk account zichtbaar. Zonder toegang antwoordt de API met een 402-fout.

Uw API-sleutel genereren

Sleutels worden in de app aangemaakt, met uw sessie. Een sleutel kan geen andere sleutel aanmaken, tonen of intrekken.

  1. Meld u aan bij de ControlResell-webapp.
  2. Open Instellingen en daarna Ontwikkelaars.
  3. Maak een sleutel: geef hem een naam, kies minstens één bereik en eventueel een vervaldatum (maximaal 5 jaar).
  4. Kopieer het geheim meteen: het wordt maar één keer getoond.

Mijn API-sleutels beheren

Het geheim begint met cr_live_. Behandel het als een wachtwoord: ControlResell bewaart er alleen een hash van en kan het niet opnieuw tonen. Bij twijfel trekt u de sleutel in en maakt u een nieuwe aan.

Stuur de sleutel mee in de Authorization-header van elke aanroep. Voorbeeld om uw profiel te lezen:

curl https://api.controlresell.com/api/public/v1/me \
  -H "Authorization: Bearer cr_live_..."

U kunt maximaal 10 actieve sleutels hebben, elk op elk moment in te trekken.

Beschikbare bereiken

  • accounts:read – Marketplace-accounts lezen
  • items:read – Artikelen en hun advertenties lezen
  • items:write – Artikelen schrijven
  • orders:read – Bestellingen lezen
  • conversations:read – Gesprekken lezen
  • conversations:write – Gesprekken schrijven

API-documentatie

De interactieve referentie (Swagger) en de OpenAPI-specificatie zijn openbaar en worden gegenereerd uit de productie-API.

De API is geversioneerd (/api/public/v1). v1 verandert alleen door toevoegingen; bij een breuk wordt een v2 geopend en blijft v1 na de aankondiging minstens twaalf maanden beschikbaar.

Officiële SDK's en CLI

SDK's gegenereerd uit de specificatie en een CLI, open source op GitHub.

De pakketten zijn nog niet gepubliceerd: binnenkort op npm, PyPI en Maven Central. Ondertussen is de broncode beschikbaar op GitHub.