API

Een API is een manier waarop andere software, zoals een BI-tool of een eigen script, gegevens uit de hub kan lezen of erin kan zetten, zonder de app te openen. Je hebt er een developer voor nodig en een API-sleutel.

Alles wat in de hub staat, kun je er met een sleutel weer uit lezen: producten, voorraad, orders, facturen, offertes, retouren, zendingen, checkouts, contacten en klanten. Schrijven kan voor producten, voorraad en klanten.

curl -H "Authorization: Bearer ck_xxxxxxxxxxxxxxxxxxxx" \
     -H "Accept: application/json" \
     "https://app.nexym.nl/api/connect/products?limit=50"

Elke sleutel hoort bij één project. Er is geen projectparameter en geen manier om erlangs te kijken: wat je terugkrijgt is altijd van jouw project.

i

Vraag altijd om JSON. Stuur Accept: application/json mee. Doe je dat niet, dan krijg je bij een fout een HTML-pagina in plaats van een nette foutmelding.

Wat er is

Resource	Lezen	Schrijven
products	ja	ja
stock	ja	ja (bijwerken)
customers	ja	ja
orders, invoices, quotes, returns, shipments, checkouts, subscribers	ja	nee

Een product in products heeft ook related_skus, upsell_skus en crosssell_skus: de gerelateerde producten, upsells en cross-sells als lijsten van SKU’s.

De volledige velden, parameters en antwoorden staan onder Referentie, rechtstreeks gegenereerd uit de specificatie van de API zelf.

Alleen wat je nodig hebt

Geef een sleutel per resource rechten. Een feedleverancier die alleen producten leest, hoort geen orders te kunnen opvragen — en als de sleutel ooit uitlekt, scheelt dat alles.