Copy page

Начало работы

Первый запрос за 5 минут

Цель этой страницы — убедиться, что ключ работает и вы видите смены лагеря. Понадобятся ключ (см. Ключ доступа и права) и терминал с curl — или любой язык программирования.

Адрес API

Code
https://partners.zvezdnyy-burabai.edu.kz/ext/v1

Все адреса в руководстве пишутся от этого начала: GET /shifts значит GET https://partners.zvezdnyy-burabai.edu.kz/ext/v1/shifts.

• Только https://. Запрос по http:// отклоняется, а ключ, который в нём был, сразу отзывается. Проверьте адрес в настройках CRM дважды.
• Версия API — в адресе (/ext/v1). Что это значит для вас — в Совместимости.
• Описание API в формате OpenAPI 3.1 можно скачать в справочнике — по нему генерируется клиент для вашего языка.

Заголовки

Тело запроса и ответа — JSON в UTF-8. Размер тела запроса — не больше 1 МБ.

В каждом ответе есть заголовок X-Request-Id — номер запроса. Сохраняйте его в своём журнале: по нему лагерь найдёт запрос, если что-то пошло не так.

Шаг 1. Кто я

Самый простой запрос — GET /me: «кто я, какой у меня отдел и какие права». Он не меняет никаких данных.

Сначала положите ключ в переменную окружения, чтобы не вставлять его в каждую команду:

Code
export ZB_KEY="zb_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"   # ваш настоящий ключ

Ответ 200 (данные вымышленные):

Code
{
  "client": { "id": "3", "name": "CRM отдела «Пример»" },
  "department": { "id": "7", "name": "Отдел продаж «Пример»" },
  "scopes": ["read", "bookings", "invoices", "webhooks"],
  "limits": {
    "read_per_sec": 10,
    "write_per_sec": 2,
    "concurrent": 10,
    "bookings_per_minute": 30,
    "invoices_per_booking_hour": 5
  }
}

• department — ваш отдел. Если здесь чужой отдел — вам выдали не тот ключ, сообщите лагерю.
• scopes — права ключа.
• limits — ваши лимиты (см. Лимиты).

В ответе могут быть и другие поля. Это нормально: незнакомые поля пропускайте (см. Совместимость).

Если ответ не 200

Шаг 2. Какие смены продаются

GET /shifts?on_sale=true — смены, на которые можно оформить бронь прямо сейчас:

Code
curl "https://partners.zvezdnyy-burabai.edu.kz/ext/v1/shifts?on_sale=true" \
  -H "Authorization: Bearer $ZB_KEY"

Ответ 200 — список порцией (подробно о порциях — в Форматах данных):

Code
{
  "items": [
    {
      "id": "12",
      "season": { "id": "2", "name": "Лето 2027" },
      "number": 3,
      "date_start": "2027-07-01",
      "date_end": "2027-07-14",
      "status": "open",
      "on_sale": true,
      "sales_close_at": "2027-06-30T19:00:00Z",
      "price": { "amount": "250000.00", "currency": "KZT" },
      "transfer_price": { "amount": "15000.00", "currency": "KZT" },
      "transfer_prices": [
        {
          "transfer_point_id": "4",
          "name": "Астана, ж/д вокзал",
          "price": { "amount": "15000.00", "currency": "KZT" }
        },
        {
          "transfer_point_id": "5",
          "name": "Караганда, автовокзал",
          "price": { "amount": "20000.00", "currency": "KZT" }
        }
      ],
      "min_payment": { "amount": "50000.00", "currency": "KZT" },
      "full_payment_due": "2027-06-24",
      "max_discount": { "amount": "20000.00", "currency": "KZT" },
      "seats": { "quota": 20, "taken": 7, "free": 13 },
      "age_groups": [
        { "squad": 1, "age_min": 7, "age_max": 9 },
        { "squad": 2, "age_min": 10, "age_max": 12 }
      ]
    }
  ],
  "next_cursor": null
}

Что здесь важно для продажи:

Готово

Если оба запроса ответили 200 — подключение работает. Дальше — Бронь и оплата по шагам.