Verzioniranje
API za trgovce i njegovi dokumenti su verzija 1 i unutar v1 samo rastu. Integracija napisana prema v1 nastavlja raditi.
Putanje, nazivi polja, kodovi pogrešaka, nazivi zaglavlja i primjeri kôda ostaju na engleskom: oni su ugovor.
Što se smije promijeniti unutar v1
- Novo neobvezno polje u odgovoru, zahtjevu ili dokumentu narudžbe.
- Nova ruta, novi kôd pogreške, novi događaj webhooka ili nova vrijednost u popisu dopuštenih vrijednosti.
- Nova shema potpisa uz
v1=uCutOptim-Signature; prijamnici ignoriraju sheme koje ne poznaju.
Što se unutar v1 nikad ne mijenja
- Nijedno polje ne nestaje, ne preimenuje se niti mijenja značenje.
- Nijedna ruta ne mijenja svoju putanju, svoj ključ ni oblik svog odgovora.
- Kôd pogreške zadržava svoje značenje.
Napišite tolerantan čitač
Ignorirajte polja koja ne poznajete, nepoznati kôd pogreške tretirajte prema njegovu HTTP statusu, a vrstu događaja webhooka na koju niste pretplaćeni prihvatite odgovorom 2xx. schemaVersion dokumenta narudžbe i svakog tijela webhooka je 1.
Promjena koja lomi kompatibilnost
Takva promjena bio bi novi dokument (order.v2) ili nova putanja (/cfg/v2) uz v1, nikad prepisivanje v1. Bila bi najavljena u popisu promjena.
Gumba „isprobaj“ ovdje namjerno nema: tajni ključ pripada vašem poslužitelju, nikad pregledniku. Demo web shop prikazuje ugradnju i predaju narudžbe u radu od početka do kraja.
Pravne informacijeUvjeti konfiguratora (EN) ·Ugovor o obradi podataka (EN) ·Obavijest o privatnosti za kupce ·Licencije trećih strana (EN)