Ограничувања и правила

Дел од правилата по кои работи интеграцискиот API не се читаат од машинскиот опис — тој кажува кои полиња постојат, но не и колку барања се дозволени, по кој редослед доаѓаат списоците, ниту колку долго трае заштитата од дупликат. Тие четири работи се напишани тука.

Правила

Правило	Вредност
граница на сообраќај	300 барања во минута, по клуч
страничење	100 стандардно, 500 највеќе
редослед на список	најнов прв
прозорец на идемпотентност	еден час

Граница на сообраќај

Дозволени се 300 барања во минута, и тие се бројат по клуч — не по адресата од која доаѓаат барањата. Тоа значи две работи, и обете се важни при планирање на распоредот:

• Еден клуч од повеќе сервери дели иста квота. Ако истиот клуч го употребуваат три инстанци на твојот производ, нивните барања се собираат во истата бројка од 300. Границата не се множи со бројот на сервери.
• Повеќе клучеви зад иста излезна адреса НЕ делат квота. Ако два твои клиенти работат од иста мрежа и излегуваат преку иста адреса, секој од нив има своја бројка. Едниот не може да ја потроши квотата на другиот.

Кога границата ќе се исполни, барањето се одбива и се повторува подоцна — не се менува ниту клучот ниту адресата.

Ако бројката или основата по која се брои се променат, промената поминува низ Changelog со најавен датум пред да важи. Нема тивка промена на границата: она што е објавено тука важи додека во Changelog не стои нов датум за него.

Повторно праќање и заштита од дупликат

Секое барање што создава документ се обележува со заглавието X-Idempotency-Key. Ознаката ја избираш ти и таа е тоа што му кажува на API-то дека две барања се всушност едно исто.

Што праќаш	Што добиваш
прв пат, со нова ознака	201 — документот е создаден
повторно, иста ознака и иста содржина	200 — истиот одговор како првиот пат, без втор документ
иста ознака, поинаква содржина	EARH-2010 · 409

Разликата меѓу 201 и 200 е тоа по што се распознава дали документот е создаден сега или веќе постоел. Обата одговора носат ист документ, па повторувањето по прекината врска е безбедно.

Третиот ред е грешка, не повторување: истата ознака со поинаква содржина значи или нов документ со стара ознака, или документ изменет по првото праќање. Што точно да се направи со неа стои кај EARH-2010 во каталогот на грешки.

Прозорецот на идемпотентност трае еден час. По него истата ознака се смета за нова.

Граница на историјата

Документи создадени пред воведувањето на идентификаторот docUid не се појавуваат преку интеграцискиот API. Тие немаат идентификатор по кој API-то може да ги адресира, па ниту еден список не ги враќа и ниту едно барање по docUid не стигнува до нив.

⚠️ Тие документи не се бројат ниту во вкупниот број (totalCount) што го враќаат списоците. Значи бројката во одговорот не е вкупниот број документи на клиентот — тоа е бројот документи достапни преку интеграцискиот API. Ако твојот производ ја споредува таа бројка со она што клиентот го гледа во eArhiva, разликата е очекувана и не е грешка.

Постарите документи и понатаму се достапни преку самата апликација; она што ова го ограничува е само интеграцискиот API.