Начало работы
У платформы три входа. Выберите тот, который подходит вашей задаче.
| Что нужно сделать | Что использовать | Адрес | Доступ |
|---|---|---|---|
| Проверить согласование, прочитать список отзывов или публичный реестр | API публичной проверки | https://verify.tanba-ooh.kz | не нужен |
| Читать свои согласования, конструкции, статистику и биллинг или создавать заявки из своей программы | API интеграции | https://app.tanba-ooh.kz | ключ API |
| Получать уведомления о событиях | Вебхуки | ваш адрес HTTPS | секрет вебхука |
| Передавать показы, которые посчитала ваша CMS | Импорт показов | https://app.tanba-ooh.kz | ключ API с правом write:plays |
Первый вызов
Для проверки согласования учетная запись не нужна. Отправьте номер и попросите JSON:
curl -H 'Accept: application/json' 'https://verify.tanba-ooh.kz/v1/approval/TNB-2026-000123'Неизвестный номер, номер неверного формата и отклоненная заявка дают один и тот же ответ 404, поэтому по ответу нельзя понять, какие номера существуют.
Соглашения
- Даты в формате ISO 8601. День это календарный день по времени Asia/Almaty, запись
YYYY-MM-DD. - Деньги в тенге. Суммы передаются строками, чтобы не потерять ни одной цифры.
- Списки выдаются страницами:
limit(от 1 до 500) иoffset. - Ошибки приходят документами problem (
application/problem+json). Полеcodeстабильно, текстыtitleиdetailмогут меняться.
{
"type": "https://tanba-ooh.kz/problems/validation_failed",
"title": "Unprocessable Entity",
"status": 422,
"code": "validation_failed",
"errors": [{"field": "period_to", "code": "required"}]
}- Публичные вызовы отвечают
429с заголовкомRetry-After, если клиент шлет слишком много запросов. Для каждого ключа API действует предел 10 запросов в секунду с всплеском до 30.
Файлы контракта
На странице каждого подключения есть ссылка на его файл OpenAPI 3.1. Эти файлы служат источником сайта, поэтому клиент, собранный по ним, всегда совпадает со страницами.
- openapi.yaml: публичные вызовы и вызовы интеграции
- webhooks.yaml: события, которые отправляет платформа