Документация Provider API
Все эндпоинты, поля, ответы и ошибки на одной странице. Примеры используют curl и JSON.
Начало работы
JSON через HTTPS. Отправляйте один запрос на клиента при каждом изменении его переключателя. Любой запрос можно безопасно повторить.
Базовый URLhttps://api.anuto.app/v1
Эндпоинты
| Эндпоинт | Значение |
|---|---|
POST/provider/clients | Активировать или обновить клиента |
GET/provider/clients/{externalId} | Статус одного клиента |
DELETE/provider/clients/{externalId} | Деактивировать клиента и снять его объявления |
POST/provider/clients/{externalId}/changes | Сообщить Anuto, что товары клиента изменились |
GET/provider/me | Проверка ключа: название поставщика, форматы и статус |
Повторы безопасны
Запросы с тем же externalId обновляют этого клиента. Дубликаты не создаются, поэтому можно повторить запрос после таймаута.
Аутентификация
Передавайте ключ в заголовке Authorization в каждом запросе. Ключи начинаются с anp_, показываются один раз и могут быть перевыпущены на странице API-ключей.
Authorization: Bearer anp_…Активировать или обновить клиента
POST/provider/clients
Передавайте данные клиента, когда его переключатель включается. Повторный запрос с тем же externalId обновит этого клиента.
curl -X POST https://api.anuto.app/v1/provider/clients \
-H "Authorization: Bearer $ANUTO_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalId": "12345",
"name": "Casa Sol Real Estate",
"email": "[email protected]",
"phone": "+34 600 000 000",
"website": "https://casasol.es",
"country": "ES",
"listingsCount": 85
}'| Поле | Обязательно | Значение |
|---|---|---|
externalId | Обязательно | Ваш ID для этого клиента (например, ID его аккаунта или компании в вашем ПО). От 1 до 100 символов. |
name | Обязательно | Название компании (до 120 символов). |
email | Обязательно | Контактный e-mail клиента. Используется для создания его аккаунта Anuto, если клиент новичок в Anuto. |
country | Обязательно | Двухбуквенный код страны ISO, например ES. |
phone | Необязательно | Контактный телефон (до 40 символов). |
website | Необязательно | Сайт клиента, http или https. |
format | Необязательно | Нужно, только если ваш доступ охватывает несколько интеграций. |
connection | Необязательно | Поля подключения для вашей интеграции, если они нужны. Какие именно, мы сообщим при одобрении доступа. |
listingsCount | Необязательно | Количество объявлений клиента, для планирования. |
test | Необязательно | Только проверяет данные и подключение. Ничего не создаётся. |
Ответ
Каждый запрос возвращает статус клиента, количество объявлений и тариф.
{
"externalId": "12345",
"clientId": "Xw3kQ9mZr2LpT7vNa4Bc",
"status": "active",
"shopUrl": "https://es.anuto.app/@casa-sol",
"listings": { "active": 10, "waiting": 0, "planWaiting": 75 },
"plan": { "tier": "free", "maxActive": 10, "freeMaxActive": 10 },
"upgradeUrl": "https://es.anuto.app/user/manage/plan",
"lastSyncAt": "2026-10-08T09:30:00.000Z"
}Статус клиента
GET/provider/clients/{externalId}
Возвращает текущий статус клиента, количество объявлений и тариф в том же формате, что и ответ на активацию.
curl https://api.anuto.app/v1/provider/clients/12345 \
-H "Authorization: Bearer $ANUTO_KEY"Деактивировать клиента
DELETE/provider/clients/{externalId}
Удаление клиента выключает его и снимает его объявления с Anuto.
curl -X DELETE https://api.anuto.app/v1/provider/clients/12345 \
-H "Authorization: Bearer $ANUTO_KEY"Уведомление об изменениях
POST/provider/clients/{externalId}/changes
Вызывайте его каждый раз, когда меняются товары клиента: объявление создано, изменено, продано или удалено. Мы пересинхронизируем этого клиента в течение нескольких минут, вместо того чтобы ждать плановой синхронизации раз в несколько часов. Вызовы в течение 5 минут объединяются, поэтому можно вызывать его при каждом изменении.
- Тело запроса необязательно. Добавьте itemIds, чтобы указать до 100 ID ваших объектов или товаров, которые изменились.
- Успешный вызов возвращает 202. nextSyncAt — время (UTC), на которое запланирована повторная синхронизация.
- Для неактивного клиента ответ содержит queued: false и сообщение. Ничего не ставится в очередь.
curl -X POST https://api.anuto.app/v1/provider/clients/12345/changes \
-H "Authorization: Bearer $ANUTO_KEY" \
-H "Content-Type: application/json" \
-d '{ "itemIds": ["123", "456"] }'{
"queued": true,
"nextSyncAt": "2026-10-08T12:00:00Z"
}Проверка ключа
GET/provider/me
Возвращает название вашего провайдера, форматы, которые покрывает ваш доступ, и статус ключа. Вызовите его первым, чтобы убедиться, что новый ключ работает.
curl https://api.anuto.app/v1/provider/me \
-H "Authorization: Bearer $ANUTO_KEY"{
"providerId": "Xw3kQ9mZr2LpT7vNa4Bc",
"name": "Your software company",
"formats": ["…"],
"status": "approved"
}Тестовый режим
Установите test в true, чтобы проверить данные и подключение. Ничего не создаётся: вы получите статус, который был бы присвоен, и результаты проверок.
{
"externalId": "12345",
"name": "Casa Sol Real Estate",
"email": "[email protected]",
"country": "ES",
"test": true
}
{
"ok": true,
"wouldBe": "active",
"checks": { "connection": "ok", "owner": "new_account" }
}Статусы клиента
- activeАктивен и синхронизируется.
- pendingПодключение пока не работает, поэтому ничего не публикуется.
- reviewAnuto проверяет его, потому что e-mail этого нового клиента уже принадлежит другому аккаунту Anuto.
- inactiveВыключен вами или удалён Anuto.
Ошибки
Неудачные запросы возвращают JSON с statusCode, code и message. Реагируйте на code; message предназначено для людей.
{
"statusCode": 404,
"code": "PROVIDER_CLIENT_NOT_FOUND",
"message": "No client with externalId 12345"
}| Код | HTTP | Значение |
|---|---|---|
PROVIDER_KEY_INVALID | 401 | Ключ отсутствует, повреждён или неизвестен. |
PROVIDER_REVOKED | 403 | Доступ вашего поставщика отозван Anuto. |
PROVIDER_FORMAT_REQUIRED | 400 | У вашего ПО несколько форматов, поэтому в запросе нужен format. |
PROVIDER_FORMAT_NOT_ALLOWED | 400 | Формат не входит в ваши одобренные форматы. |
PROVIDER_CLIENT_NOT_FOUND | 404 | У вашего поставщика нет клиента с таким externalId. |
Лимиты запросов
При превышении лимита вы получите 429 с заголовком Retry-After. Подождите указанное число секунд и повторите запрос.
Вопросы об API или о вашем доступе? [email protected]