Жұмысты бастау
Платформаның үш есігі бар. Қажетіңізге сәйкес келетінін таңдаңыз.
| Мақсатыңыз | Не пайдалану керек | Хост | Тіркелгі |
|---|---|---|---|
| Келісуді тексеру, кері қайтару тізімін немесе жария тізілімді оқу | Жария тексеру API | https://verify.tanba-ooh.kz | қажет емес |
| Келісулерді, құрылымдарды, статистика мен есептеулерді оқу немесе өз бағдарламаңыздан өтінім жасау | Интеграция API | https://app.tanba-ooh.kz | API кілті |
| Бір нәрсе болғанда хабарлама алу | Вебхуктер | өз HTTPS мекенжайыңыз | вебхук құпиясы |
| Өз CMS жүйеңіз санаған көрсетілімдерді жіберу | Көрсетілімдерді импорттау | https://app.tanba-ooh.kz | write:plays рұқсаты бар API кілті |
Алғашқы сұрау
Келісуді тексеруге тіркелгі қажет емес. Нөмірді жіберіп, 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"}]
}- Клиент тым көп сұрау жіберсе, жария шақырулар
Retry-Afterтақырыбымен429жауап береді. Әр API кілті секундына 10 сұраумен шектелген, жылдам жіберу көлемі 30.
Шарт файлдары
Әр қосылым бетінде оның OpenAPI 3.1 файлына сілтеме бар. Файлдар осы сайттың бастапқы көзі, сондықтан олар бойынша жасалған клиент әрдайым беттерге сәйкес келеді.
- openapi.yaml: жария және интеграция шақырулары
- webhooks.yaml: платформа жіберетін оқиғалар