Верзионирање и стабилност
Интеграцискиот API се верзионира по само-додавачки принцип: во оваа верзија на API-то само се додава. Постоечко поле не се брише и не го менува значењето. Промена што го крши тоа не влегува во тековната верзија — таа носи нова верзија на API-то.
Што влегува, што бара нова верзија
Дел со наслов „Што влегува, што бара нова верзија“| Промена | Исход |
|---|---|
| ново незадолжително поле во одговор | влегува во оваа верзија |
| нова вредност во кодна листа | влегува во оваа верзија |
| нова адреса | влегува во оваа верзија |
| бришење на постоечко поле | бара нова верзија на API-то |
| промена на значењето на поле | бара нова верзија на API-то |
| ново задолжително поле во барањето | бара нова верзија на API-то |
API клиент што игнорира поле што не го препознава не се крши од првите три реда — тие само додаваат. Последните три ја менуваат постоечката форма и затоа бараат нова верзија, објавена одделно.
Истото правило важи и за шифрите во кодните листи:
- Постоечка шифра никогаш не го менува значењето. Шифра што денес значи едно, не почнува да значи друго во подоцнежно издание.
- Повлечена шифра не се употребува повторно за друго. Штом една шифра излезе од употреба, таа остава празна — не се доделува на нова вредност.