Авторизация

Basic Authentication

Все запросы к API требуют Basic Authentication и должны выполняться только с IP-адресов, зарегистрированных в агенте.

Обязательные требования

1. IP-адреса

Запросы должны поступать только с предварительно зарегистрированных IP-адресов. В противном случае доступ будет заблокирован.

2. Basic Authentication

Необходимо передавать учетные данные клиента в заголовке Authorization:
Authorization: Basic <base64_encoded_credentials>

Пример

bash
curl -X GET "https://accruals-gateway.doma.ai/api/search?search=Столичный" \ -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ="

Ошибки авторизации

Код ошибкиHTTP статусСообщениеПричина
AGENT_NOT_FOUND404Agent is not foundПереданный username не соответствует ни одному зарегистрированному агенту
AGENT_DISABLED403Agent is disabledАгент существует, но отключен в системе
IP_NOT_ALLOWED403IP address not allowedЗапрос выполнен с незарегистрированного IP-адреса
INVALID_HEADERS403Invalid headers providedПрисутствуют некорректные загловки
AUTHORIZATION_REQUIRED403Authorization requiredОтсутствует заголовок Authorization или неверные учетные данные