PIM API izstrādātājiem
PIM API ļauj tavai sistēmai (ERP, veikalam, noliktavai) lasīt un rakstīt produktu datus.
Pilna, dzīva dokumentācija ar tava uzņēmuma īpašību vārdnīcu, limitiem un piemēriem ir PIM: sānjoslā Palīdzība (adrese
https://data.ecomcart.store/api-doc).
Pamati
- Bāzes adrese: https://data.ecomcart.store/api/v1
- Autentifikācija: galvene Authorization: Bearer <atslēga> (vai X-Api-Key: <atslēga>)
- Formāts: JSON
Atslēgu izveido Iestatījumi → API atslēgas ar servisu PIM API — sk. API atslēgas.
curl -H "Authorization: Bearer $PIM_KEY" \
https://data.ecomcart.store/api/v1/meta
Galvenie galapunkti
| Galapunkts | Ko dara | |---|---| | /products | Produktu saraksts, izveide, maiņa; arī /resolve, /locks, /media | |
/suppliers/{code}/products | Piegādātāja piedāvājumu iesūtīšana | | /jobs/{id} | Fona darba stāvoklis | | /categories,
/manufacturers, /suppliers | Uzziņu dati | | /attributes, /attribute-families, /attribute-groups, /options | Īpašību
vārdnīca | | /media/{id}/file | Attēla vai faila lejupielāde | | /meta | Tava konta limiti un iestatījumi (mašīnlasāmi)
| | /events | Visu notikumu žurnāls (droša alternatīva webhookiem) |
Limiti
Limiti ir uz uzņēmumu (ne uz atslēgu), un tie atkarīgi no plāna:
- pieprasījumi minūtē — galvenes X-RateLimit-Limit / X-RateLimit-Remaining;
- vienības minūtē partiju galapunktos — X-RateLimit-Items-Limit / X-RateLimit-Items-Remaining;
- atsevišķs limits ?sync=1 pieprasījumiem.
Pārsniedzot limitu, atbilde ir 429 ar galveni Retry-After — pagaidi norādītās sekundes.
Biežākās kļūdas
| Kods | Nozīme | |---|---| | 401 | Nav atslēgas vai tā nav derīga | | 403 | Atslēgai nav vajadzīgo tiesību (key_scope)
vai uzņēmums ir apturēts | | 404 | Objekts nav atrasts (vai nav tavā sortimentā) | | 422 | Kļūdaini dati — sk. atbildes
errors | | 429 | Pārsniegts limits — sk. Retry-After |
Notikumi
Izmaiņām vari sekot ar webhookiem vai periodiski lasot /events.
