Versionamento
L'API per i commercianti e i suoi documenti sono alla versione 1, e all'interno della v1 possono solo crescere. Un'integrazione scritta per la v1 continua a funzionare.
Percorsi, nomi dei campi, codici di errore, nomi degli header ed esempi di codice restano in inglese: sono il contratto.
Cosa può cambiare all'interno della v1
- Un nuovo campo opzionale in una risposta, in una richiesta o nel documento d'ordine.
- Una nuova rotta, un nuovo codice di errore, un nuovo evento webhook o un nuovo valore in un elenco di valori consentiti.
- Un nuovo schema di firma accanto a
v1=inCutOptim-Signature; i ricevitori ignorano gli schemi che non conoscono.
Cosa non cambia mai all'interno della v1
- Nessun campo scompare, viene rinominato o cambia significato.
- Nessuna rotta cambia il suo percorso, la sua chiave o la forma della sua risposta.
- Un codice di errore mantiene il suo significato.
Scrivi un lettore tollerante
Ignora i campi che non conosci, tratta un codice di errore sconosciuto in base al suo stato HTTP e accetta con un 2xx un tipo di evento webhook a cui non ti sei iscritto. La schemaVersion del documento d'ordine e di ogni corpo webhook è 1.
Una modifica incompatibile
Una modifica incompatibile sarebbe un nuovo documento (order.v2) o un nuovo percorso (/cfg/v2) accanto alla v1, mai una riscrittura della v1. Verrebbe annunciata nel Registro delle modifiche.
Qui non c'è un pulsante "provalo" di proposito: la chiave segreta appartiene al tuo server, mai a un browser. Lo shop demo mostra l'incorporamento e il passaggio dell'ordine in funzione da un capo all'altro.
Note legaliCondizioni del configuratore (EN) ·Accordo sul trattamento dei dati (EN) ·Informativa privacy per gli acquirenti ·Licenze di terze parti (EN)