Технічний опис REST API сервісу
Публічне REST API сервісу дозволяє організатору отримувати інформацію про поточні заходи, дати проведення, оформлені замовлення, клієнтів та результат перевірки квитків.
Доповнення та розширення API відбувається відповідно до потреб та запитів організаторів. Підтримка - support@event.net.ua
Авторизація
Авторизація відбувається методом Bearer Token, значення токену ви можете отримати в кабінеті організатора "Налаштування" - "Відстеження, конверсії, API".
Формат
Формат відповідь на API запит - JSON
Інформація по заходам
Інформація по заходу
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/events/view |
Параметри запиту: має бути заданий хоча б один параметр.
| Поле | Тип | Значення |
|---|---|---|
| id | int | ідентифікатор заходу, в кабінеті організатора позначається як "ID заходу для додатку" |
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/events/date?id=63
Відповідь
У відповідь на запит отримується JSON масив з ключами:
– ’event’ - загальна інформація про захід
– ’dates’ - масив записів з інформацією про дати проведення
Поля для ключа ’event’
| Поле | Тип | Значення |
|---|---|---|
| statut | int | статус заходу |
| mode | int | режим продажу |
| titre | string | назва заходу |
| address | string | місце проведення |
| descriptif | string | код причини заборони входу |
| max_visitors | ?int | максимальна кількість відвідувачів |
| currency | string | код валюти для заходу |
Поля для ключа dates
| Поле | Тип | Значення |
|---|
| id_date | int | ідентифікатор дати проведення |
| statut | int | аналогічно статусам заходу |
| date_start | string | Дата початку заходу, YYYY-MM-DD HH::II |
Інформація по замовленням
Список замовлень
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/orders/list |
Параметри запиту - має бути заданий один з параметрів: id_event, id_date, date.
| Поле | Тип | Значення |
|---|---|---|
| id_event | int | ідентифікатор заходу |
| id_date | int | ідентифікатор дати проведення |
| date | string | фільтр по даті, формат YYYY-MM-DD |
| statut | int | фільтр по статусу замовлення |
Якщо параметри не задані, то повертається перелік всіх замовлень за сьогодні.
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/orders/list?id_event=1&statut=15
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| id_order | int | # замовлення |
| statut | int | статус замовлення |
| id_event | int | ідентифікатор заходу |
| id_date | int | ідентифікатор дати проведення |
| id_customer | int | ідентифікатор покупця, 0 - анонімний покупець |
| id_ps | int | метод оплати |
| miktar | int | кількість квитків у замоленні |
| toplam | float | сума замовлення |
| currency | string | код валюти для заходу |
| date_create | string | дата створення замовлення |
Інформація про замовлення
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/orders/view |
Параметри запиту
| Поле | Тип | Значення |
|---|---|---|
| id | int | (required) номер замовлення |
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/orders/view?id=1303
Відповідь
У відповідь на запит отримується JSON масив з ключами:
– ’order’ - загальна інформація про замовлення
– ’items’ - масив записів з інформацією про замовлені квитки
Поля для ключа ’order’
| Поле | Тип | Значення |
|---|---|---|
| id_order | int | # замовлення |
| statut | int | статус замовлення |
| id_event | int | ідентифікатор заходу |
| id_date | int | ідентифікатор дати проведення |
| id_customer | int | ідентифікатор покупця, 0 - анонімний покупець |
| id_ps | int | метод оплати |
| fname | string | ім’я |
| lname | string | прізвище |
| string | ємейл | |
| phone | string | телефон |
| company | string | компанія |
| position | string | посада |
| miktar | int | кількість квитків у замовленні |
| cartcode | string | код промоквитка |
| promo | string | код промокода |
| toplam_init | float | сума замовлення до знижки |
| discount_percent | int | відсоток знижки |
| discount_toplam | float | сума знижки |
| toplam | float | фінальна сума замовлення |
| currency | string | код валюти для заходу |
| date_visit | string | бажана датат візиту ( для екскурсій з відкритою датою) |
| date_create | string | дата створення замовлення |
| maj | string | дата останнього оновлення замовлення |
Поля для ключа items
| Поле | Тип | Значення |
|---|---|---|
| id_item | int | # квитка |
| id_order | int | # замовлення |
| statut | int | статус квитка відповідно проходження контролю |
| id_event | int | ідентифікатор заходу |
| id_date | int | ідентифікатор дати проведення |
| id_ticket | int | ідентифікатор групи квитків |
| titre | string | назва квитка |
| fname | string | ім’я |
| lname | string | прізвище |
| string | ємейл | |
| phone | string | телефон |
| company | string | компанія |
| position | string | посада |
| price_init | float | кошторисна вартість квитка |
| price | float | фінальна фінальна вартість квитка ( після знижки) |
| currency | string | код валюти для заходу |
| date_create | string | дата створення замовлення |
| maj | string | дата останнього оновлення замовлення |
Інформація по перевірці квитків
Журнал перевірки квитків
Лог успішних та неуспішних перевірок квитків. Можна отримати всі операції за певний день або по визначенному квитку.
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/checkin/journal |
Параметри запиту: має бути заданий хоча б один параметр.
| Поле | Тип | Значення |
|---|---|---|
| id_item | int | ідентифікатор квитка |
| date | string | YYYY-MM-DD день |
Запит повертає весь лог перевірки для квитка id_item=1
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/checkin/journal?id_item=1
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| id_checkin | int | # запису лога |
| source | int | джерело перевірки: 1 - виконано через кабінет організатора; 2 - сканування мобільним додатком |
| id_item | int | # квитка |
| action | int | результат перевірки: 1 - заборона входу; 2 - виконано вхід; 3 - виконано вихід |
| descriptif | string | код причини заборони входу |
| id_user | int | користувач, який виконав операцію (фіксується тільки для операцій в кабінеті організатора) |
| date_create | string | дата та час сканування |
Статус квитків на дату проведення
Повертає перелік оплачених квитків на обрану дату проведення та поточний статус квитка відповідно походженню контролю.
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/checkin/date |
Параметри запиту
| Поле | Тип | Значення |
|---|---|---|
| id_date | int | (required) ідентифікатор дати проведення |
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/checkin/date?id_date=207
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| id_order | int | # замовлення |
| id_item | int | # квитка |
| statut | int | статус квитка відповідно проходження контролю |
Довідники
Перелік методів оплати організатора
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/lexicon/pay-systems |
без параметрів
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/lexicon/pay-systems
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| id_ps | int | ідентифікатор метода оплати |
| titre | string | назва метода оплати |
Перелік статусів заходу
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/lexicon/event-statuts |
без параметрів
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/lexicon/event-statuts
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| statut | int | значення статусу |
| titre | string | назва статусу |
Режими продажу заходу
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/lexicon/event-modes |
без параметрів
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/lexicon/event-modes
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| statut | int | значення режиму |
| titre | string | назва режиму |
Перелік статусів замовлень
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/lexicon/order-statuts |
без параметрів
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/lexicon/order-statuts
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| statut | int | значення статусу |
| titre | string | назва статусу |
Перелік статусів квитка
Описують статус квитка відповідно до проходження контролю.
Статус "зайшов" - означає що квиток був успішно перевірений і наразі погашений. Подальші спроби сканування квитка будуть закінчуватися помилкою "спроба повторного входу".
Статус "вийшов" означає, що квиток був повернутий до початкового стану і квиток може бути повторно успішно відсканований.
Запит
| Тип запиту | URL |
|---|---|
| GET | https://api.event.net.ua/v1/lexicon/item-statuts |
без параметрів
curl -X GET -H "Authorization: Bearer YOUR_TOKEN_HERE" https://api.event.net.ua/v1/lexicon/item-statuts
Відповідь
| Поле | Тип | Значення |
|---|---|---|
| statut | int | значення статусу |
| titre | string | назва статусу |
Вартість сервісу
- Індивідуальна
- спеціальні умови для музеїв, заповідників та закладів музейного типу
Ви отримуєте
- брендування посадкової сторінки
- консультація по підключенню платіжної системи
- допомога з інтеграцією в ваш сайт
- повне налаштування і запуск
