xcaDocs
Початок роботи

Автентифікація

Як передавати API-ключ і зберігати його в безпеці.

Кожен запит має містити твій API-ключ. Передавай його в заголовку Authorization як bearer-токен або в заголовку X-Api-Key, якщо клієнт не вміє задавати Authorization.

Заголовки#

Authorization: Bearer xca_live_…
# or
X-Api-Key: xca_live_…
curl -s "https://app.xca.fun/api/v1/new-pairs?limit=5" \
  -H "X-Api-Key: $XCA_API_KEY"

Формат ключа#

Ключі починаються з xca_live_, далі йде випадковий рядок у base58. XCA зберігає лише хеш ключа, тож втрачений ключ не відновити — створи новий.

Тримай ключі в секреті#

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

Заміна ключа#

Створи новий ключ, задеплой його, переконайся, що запити проходять, і відклич старий на сторінці API.

Помилки автентифікації#

Відсутній, некоректний або відкликаний ключ повертає 401 unauthorized. Дійсний ключ на тарифі без доступу до API повертає 402 planRequired.

401
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}