Înainte de a apela API-ul
Autentificare
Verificați autentificarea.
Disponibil începând cu
Verificați dacă planul magazinului include funcția API necesară.
Permisiuni necesare
Verificați permisiunile cheii și condițiile câmpurilor trimise.
Ce plan este necesar
| Disponibil începând cu | Descriere |
|---|---|
| BASIC | BASIC include citirea comenzilor și a solicitărilor clienților, schimbarea stărilor acestora, schimbarea stării plății unei comenzi și a sumei de rambursare înregistrate. |
| STANDARD | Operațiile asupra catalogului, CMS, căutării și stocurilor necesită STANDARD sau un plan superior. |
Magazinele cu abonamente existente primesc funcțiile API incluse în planul lor.
Permisiunile unei operațiuni
- Documentația prezintă required_scopes pentru fiecare operație și conditional_scopes pentru câmpurile sau modificările sensibile.
- Dreptul de citire a unei resurse nu acordă dreptul de creare, editare sau ștergere.
- Obținerea tokenului și accesarea contextului necesită autentificare chiar dacă nu este indicată o permisiune asupra resurselor.
Listează
GET/api/v1/products
- Autentificare
Bearer- Disponibil începând cu
- STANDARD
- Permisiuni necesare
catalog.product:read
Actualizează
PATCH/api/v1/products/{product_id}
- Autentificare
Bearer- Disponibil începând cu
- STANDARD
- Permisiuni necesare
catalog.product:update
Când sunt necesare permisiuni suplimentare
Actualizează
PATCH/api/v1/products/{product_id}
- Autentificare
Bearer- Disponibil începând cu
- STANDARD
- Permisiuni necesare
catalog.product:update- Permisiuni suplimentare pentru câmpurile selectate
- Când este inclus variant_value_ids:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - Când este inclus variants_enabled:
catalog.product_variant:update
- Când este inclus variant_value_ids:
Ce se întâmplă la schimbarea planului
Când trecerea la un plan inferior elimină o permisiune, aceasta este eliminată din cheile API și apare debifată și dezactivată în panoul de administrare.