Verzování
API pro obchodníky a jeho dokumenty mají verzi 1 a v rámci v1 jen přibývají. Integrace napsaná proti v1 dál funguje.
Cesty, názvy polí, chybové kódy, názvy hlaviček a ukázky kódu zůstávají anglicky: jsou součástí kontraktu.
Co se smí v rámci v1 změnit
- Nové volitelné pole v odpovědi, požadavku nebo dokumentu objednávky.
- Nová routa, nový chybový kód, nová událost webhooku nebo nová hodnota v seznamu povolených hodnot.
- Nové schéma podpisu vedle
v1=vCutOptim-Signature; přijímače schémata, která neznají, ignorují.
Co se v rámci v1 nikdy nemění
- Žádné pole nezmizí, nepřejmenuje se ani nezmění význam.
- Žádná routa nezmění svou cestu, svůj klíč ani tvar své odpovědi.
- Chybový kód si zachovává svůj význam.
Pište tolerantní čtečku
Ignorujte pole, která neznáte, neznámý chybový kód posuzujte podle jeho HTTP stavu a typ události webhooku, který jste neodebírali, přijměte odpovědí 2xx. schemaVersion dokumentu objednávky i každého těla webhooku je 1.
Zásadní změna
Zásadní změnou by byl nový dokument (order.v2) nebo nová cesta (/cfg/v2) vedle v1, nikdy přepsání v1. Byla by oznámena v seznamu změn.
Tlačítko „vyzkoušet“ tu záměrně není: tajný klíč patří na váš server, nikdy do prohlížeče. Demo obchod ukazuje vložení i předání objednávky v provozu od začátku do konce.
Právní informacePodmínky konfigurátoru (EN) ·Smlouva o zpracování údajů (EN) ·Zásady ochrany osobních údajů pro kupující ·Licence třetích stran (EN)