Общие принципы

API принемает GET и POST HTTP запросы. В случае успешного запроса сервер отвечает статусом 200.

Формат JSON ответа от сервера:

{
	"data": {},
	"errors": [],
	"status": "ok"
}
  • data - [] или {}
  • errors - список ошибок
  • status - ok или bad

При авторизации система выдает sid, все последующие запросы выполняются передачей этого идентификатора. Cрок жизни идентификатора 15 минут. Обновлять его требуется только при получении ошибки WrongSIDException в поле errors.

Следующие сценарии будут расценены сервером как избыточные и могут отбрасываться:

  • Авторизация и получение SID перед каждым запросом;
  • Обращение к серверу со скоростью чаще, чем 10 вызовов в минуту;

В связи с тем, что доступ по API предоставляется бесплатно, компания SAURES для обеспечения равномерной нагрузки на сетевое и серверное оборудование оставляет за собой право ограничивать количество запросов в единицу времени, а также может создавать БАН листы IP адресов нарушителей. Необходимо использовать принцип необходимого и достаточного объема обмена данными с сервером!

© 2020 SAURES - система автоматизированного учета и контроля ресурсов