Kimlik doğrulama

Her istekte API anahtarın bulunmalı. Anahtarı Authorization başlığında bearer token olarak gönder; istemcin Authorization başlığını ayarlayamıyorsa X-Api-Key başlığını kullan.

Başlıklar#

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"

Anahtar formatı#

Anahtarlar xca_live_ ile başlar, ardından rastgele bir base58 dizesi gelir. XCA anahtarın yalnızca hash’ini saklar, bu yüzden kaybolan bir anahtar kurtarılamaz: yenisini oluştur.

Anahtarlarını gizli tut#

• API’yi kendi sunucundan ya da botundan çağır; asla herkese açık bir web sayfasından veya bir mobil uygulama paketinden çağırma.
• Anahtarları repolara commit etme; onları ortam değişkenlerinden ya da bir secret manager’dan yükle.
• Her proje için ayrı bir anahtar kullan; böylece diğerlerine dokunmadan birini iptal edebilirsin.
• İptal edilen anahtarlar anında çalışmayı bırakır.

Anahtarı yenileme#

Yeni bir anahtar oluşturup devreye al, isteklerin başarılı olduğunu kontrol et, ardından API sayfasında eskisini iptal et.

Kimlik doğrulama hataları#

Eksik, hatalı biçimlendirilmiş ya da iptal edilmiş bir anahtar 401 unauthorized döndürür. API erişimi olmayan bir plandaki geçerli bir anahtar ise 402 planRequired döndürür.

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