Picked-documentatie voor ontwikkelaars
Koppel je ERP, webshop of eigen software aan je Picked-magazijn via de Picked-API.
Waar begin je
- Aan de slag: maak een API-token aan en doe je eerste aanroep.
- Authenticatie en rechten: welk token welk endpoint mag aanroepen.
- API-referentie: elk endpoint met zijn parameters en antwoorden (Engelstalig).
Handleidingen
- Foutmeldingen: elke foutcode, en of je het opnieuw probeert.
- Rate limits: hoeveel aanroepen je mag doen, en wat je doet als je erboven zit.
- Idempotentie: welke aanroepen je veilig opnieuw kunt sturen.
- Voorraadwijzigingen doorbladeren: voorraadwijzigingen pollen zonder er een te missen.
- Proefruns: een schrijfaanroep proberen zonder iets te schrijven.
- Versies en uitfasering: wat er in v1 kan veranderen, en wat niet.
- Changelog: elke wijziging in de API.
Recepten
- Misschien heb je de API niet nodig: de webshops, ERP's, vervoerders en spreadsheets waarmee Picked zelf koppelt.
- Orders doorsturen vanuit je ERP of webshop: stuur orders naar het magazijn.
- De voorraad in je webshop bijhouden: publiceer wat je kunt verkopen.
- Een levering aanmelden: laat het magazijn weten wat er komt en volg de ontvangst.
- Een proces hervatten vanuit een ander systeem: laat een proces wachten op een signaal van je systeem.
- Een procesrun starten vanuit een ander systeem: zet een stuk werk op de vloer, met zijn startvariabelen.
- Laat je systeem over een stap beslissen: een stap roept je systeem aan en wacht op het antwoord.
- Een AI-agent koppelen via MCP: laat je eigen agent processen bouwen.
Hoe de API werkt
De API staat op https://picked.nl/api/v1. Elk verzoek draagt een bearer-token dat bij één werkruimte hoort, en een token kan alleen wat zijn rechten toestaan.
Antwoorden dragen _links in HAL-stijl, elk een href onder de host. Een resource die je los kunt lezen linkt naar zichzelf (_links.self); een pagina linkt naar zichzelf en, zolang ze er zijn, naar de pagina's ernaast (_links.next, _links.prev); een cursorfeed linkt zijn volgende lezing zolang er meer wacht. Een aanroep die iets maakt antwoordt 201 met een Location-header waar je het leest. Volg de links in plaats van zelf paden te bouwen.