Перейти до вмісту
Почати безкоштовно

Розробникам

Вебзастосунок Checkpoint — це тонка надбудова над HTTP-API, і той самий API відкритий для вас. Окремої реєстрації розробника та ключів API немає: ви автентифікуєтеся звичайним обліковим записом Checkpoint.

Середовище Базовий URL
Продакшен https://api.checkpointrun.com
Тестове https://dev.api.checkpointrun.com

Розробляйте на тестовому середовищі. Там працює той самий код, трохи попереду продакшену, а його дані одноразові: їх можуть стерти без попередження — саме те, що потрібно, поки ви експериментуєте.

Кожне середовище віддає власний опис OpenAPI та браузер для нього:

  • /swagger — усі ендпоінти з параметрами й відповідями та кнопкою «try it out»
  • /swagger/v1/swagger.json — сам документ OpenAPI, який більшість генераторів клієнтів приймає як є

Документація публічна, а описані в ній операції — ні: кожна так само перевіряє ті самі права, що й застосунок. Можливість прочитати про ендпоінт не означає можливості його викликати.

Надішліть свою пошту та пароль Checkpoint — і отримаєте bearer-токен:

Terminal window
curl -X POST https://api.checkpointrun.com/login \
-H 'content-type: application/json' \
-d '{"email":"you@example.com","password":"your-password"}'
{ "tokenType": "Bearer", "accessToken": "", "expiresIn": 3600, "refreshToken": "" }

Передавайте його з кожним наступним викликом:

Terminal window
curl https://api.checkpointrun.com/api/me/alerts \
-H "Authorization: Bearer $ACCESS_TOKEN"

Токен доступу живе годину. Щоб отримати нову пару, не питаючи пароль знову, надішліть токен оновлення на /refresh:

Terminal window
curl -X POST https://api.checkpointrun.com/refresh \
-H 'content-type: application/json' \
-d '{"refreshToken":"…"}'

Вебзастосунок входить через той самий ендпоінт із ?useCookies=true і отримує натомість cookie сесії. Цей шлях — для браузерів на власних доменах Checkpoint; як клієнт API використовуйте токен.

Що можна читати без входу

Section titled “Що можна читати без входу”

Публічний вміст не потребує токена взагалі: список подій, публічні дистанції, клуби та карти, а також протоколи результатів. Усе приватне, усе про вас і будь-який запис потребують токена.

100 запитів на хвилину — рахуються за обліковим записом, коли ви автентифіковані, і за IP-адресою до того. Понад ліміт повертається 429; вікно фіксоване, тож достатньо дочекатися наступного.

Що варто знати заздалегідь

Section titled “Що варто знати заздалегідь”
  • Переліки — рядки, а не числа. Статус події приходить як "Finalized", статус заявки — як "Waitlisted". Порівняння з числом мовчки не збігнеться ніколи — помилка, якої ми припускалися самі.
  • Позначки часу — ISO-8601 зі зсувом, у UTC, наприклад 2026-08-14T20:28:26.335649+00:00.
  • API поки не версіонується, і контракт може змінюватися. Це той самий API, яким користується застосунок, тож він рухається разом із ним. Після оновлення краще перечитати документ OpenAPI, ніж покладатися на побачене одного разу.
  • Браузерні застосунки на інших доменах викликати його не зможуть. CORS дозволяє лише власні фронтенди Checkpoint, тому звертайтеся до API із сервера, зі скрипта або з нативного застосунку, а не з чужої вебсторінки.

Посилання для поширення

Section titled “Посилання для поширення”

У подій, дистанцій, клубів, карт і опублікованих результатів є ще короткі публічні посилання на https://go.checkpointrun.com: у чаті вони розгортаються в картку-прев’ю, а справжній браузер перенаправляють до Checkpoint.

Якщо вам бракує ендпоінта або гарантії, якої ми поки не даємо, напишіть про це на дошці ідей — туди ж потрапляють інші побажання, і її читають.