API интеграции
Работает Вы вызываете платформу
Чтение согласований, конструкций, статистики и начислений, создание заявок и загрузка их материалов, выгрузка тех же данных в CSV.
- Для кого
- Операторы, агентства и системы уполномоченного органа, которые подключают свое программное обеспечение по ключу API
- Базовый адрес
https://app.tanba-ooh.kz- Версия контракта
1.0.0
Руководства по теме
- Аутентификация и ключи API
- Как подать материал на согласование
- Как читать ведомость и проверять ее доказательства
- Где в консоли найти ведомость и ее доказательства
Скачать файл OpenAPI (openapi.yaml)
Операции
| Метод | Путь | Кратко |
|---|---|---|
| GET | /api/v1/approvals | List approvals |
| GET | /api/v1/approvals/{number} | One approval with its manifest |
| GET | /api/v1/approvals/{number}/media | The approved media file |
| GET | /api/v1/submissions/{id}/manifest | Manifest of an approved submission |
| GET | /api/v1/structures | List structures |
| GET | /api/v1/structures/{id} | One structure |
| GET | /api/v1/billing/periods | Billing periods with totals |
| GET | /api/v1/billing/periods/{id} | One billing period with its accrual lines |
| GET | /api/v1/billing/accruals/{id}/evidence | Evidence pack of one bill line |
| GET | /api/v1/billing/statements/{id}/evidence | Evidence pack of a statement |
| GET | /api/v1/stats/evidence.zip | Evidence pack of a structure and a period |
| GET | /api/v1/categories | Advertiser product categories |
| POST | /api/v1/submissions | Create a submission (draft) |
| GET | /api/v1/market/multipliers | The audience multiplier of a quarter hour of a screen |
| GET | /api/v1/structure-sets | List the saved structure sets of the organisation |
| POST | /api/v1/structure-sets | Save a structure set |
| PUT | /api/v1/structure-sets/{id} | Replace a structure set |
| DELETE | /api/v1/structure-sets/{id} | Delete a structure set |
| POST | /api/v1/submissions/{id}/submit | Send a draft for review |
| POST | /api/v1/submissions/{id}/media | Upload the media file of a draft |
| POST | /api/v1/plays/claims | Передача заявленных показов биржи |
| GET | /api/v1/plays/claims/verification | Сверка заявленных показов с подтвержденными плеерами |
| GET | /api/v1/exports/approvals.csv | Approvals as CSV |
| GET | /api/v1/exports/structures.csv | Structures as CSV |
| GET | /api/v1/exports/stats.csv | Plays per structure and day as CSV |
| GET | /api/v1/stats/reports | City operational report - plays and screens, load, anomalies |
| GET | /api/v1/stats/audience | Estimated audience of the complete plays |
| GET | /api/v1/exports/audience.csv | Estimated audience as CSV |
| GET | /api/v1/exports/stats-reports/{name} | One section of the city operational report as CSV |
| GET | /api/v1/exports/billing.csv | Billing accrual lines as CSV |
| GET | /api/v1/billing/reports | Money report - accrued, invoiced, paid and outstanding |
| GET | /api/v1/billing/reports/payers/{id} | Drill-down from one payer to its periods, documents and accrual lines |
| GET | /api/v1/exports/billing-reports/{name} | One money report section as CSV |
| GET | /api/v1/delivery/approvals/{number} | Delivery report of one approval |
| GET | /api/v1/delivery/campaigns | List the delivery campaigns of the organisation |
| GET | /api/v1/delivery/campaigns/{id} | One delivery campaign |
| GET | /api/v1/delivery/certificates | List the delivery certificates of the organisation |
| GET | /api/v1/delivery/certificates/{id} | One delivery certificate, its document or its PDF |
| GET | /api/v1/delivery/exports | List the per-spot export jobs of the organisation |
| GET | /api/v1/delivery/exports/{id} | State of one per-spot export job |
| GET | /api/v1/delivery/exports/{id}/file | The CSV file of a finished export job |
Технический текст справочника написан на английском.