Versionare
API-ul pentru comercianți și documentele sale sunt versiunea 1, iar în v1 doar cresc. O integrare scrisă pentru v1 continuă să funcționeze.
Căile, numele câmpurilor, codurile de eroare, numele anteturilor și exemplele de cod rămân în engleză: ele sunt contractul.
Ce se poate schimba în v1
- Un câmp opțional nou într-un răspuns, o cerere sau documentul comenzii.
- O rută nouă, un cod de eroare nou, un eveniment de webhook nou sau o valoare nouă într-o listă de valori permise.
- O schemă de semnătură nouă lângă
v1=înCutOptim-Signature; receptoarele ignoră schemele pe care nu le cunosc.
Ce nu se schimbă niciodată în v1
- Niciun câmp nu dispare, nu este redenumit și nu își schimbă sensul.
- Nicio rută nu își schimbă calea, cheia sau forma răspunsului.
- Un cod de eroare își păstrează sensul.
Scrieți un cititor tolerant
Ignorați câmpurile pe care nu le cunoașteți, tratați un cod de eroare necunoscut după starea sa HTTP și acceptați cu un 2xx un tip de eveniment de webhook la care nu v-ați abonat. schemaVersion al documentului comenzii și al fiecărui corp de webhook este 1.
O modificare incompatibilă
O modificare incompatibilă ar fi un document nou (order.v2) sau o cale nouă (/cfg/v2) lângă v1, niciodată o rescriere a v1. Ar fi anunțată în Jurnalul de modificări.
Aici nu există intenționat un buton „încearcă”: cheia secretă aparține serverului dumneavoastră, niciodată unui browser. Magazinul demo arată integrarea și predarea comenzii funcționând de la cap la coadă.
JuridicTermenii configuratorului (EN) ·Acord de prelucrare a datelor (EN) ·Notă de confidențialitate pentru cumpărători ·Licențe terțe (EN)