Giriş

Apex Brokerage Integration API dokümantasyonuna hoş geldiniz.

Bu API, Apex Brokerage platformu ile programatik olarak entegre olmanıza olanak tanır. RESTful API'miz aracılığıyla node'lar, marketler, distribütörler, token'lar ve daha fazlasını yönetebilirsiniz.

Temel URL

https://api.apex.com/api/v1/integration

Kimlik Doğrulama

Tüm API istekleri (kimlik doğrulama endpoint'leri hariç) Bearer token kullanarak kimlik doğrulama gerektirir. Detaylar için Kimlik Doğrulama bölümüne bakın.

Gerekli Header'lar

Tüm API istekleri X-Target-Server header'ını gerektirir:

• Kimlik doğrulama endpoint'leri (/auth/authenticate ve /auth/refresh): X-Target-Server: authentication kullanın
• Diğer tüm endpoint'ler: X-Target-Server: integration kullanın

Hız Sınırları

API istekleri adil kullanımı sağlamak için hız sınırlamasına tabidir. Mevcut limitler:

• API anahtarı başına dakikada 50 istek

Yanıt Formatı

Tüm API yanıtları JSON formatındadır. Başarılı yanıtlar 2xx aralığında HTTP durum kodları döndürürken, hatalar 4xx veya 5xx durum kodları döndürür.

Hata Yanıtları

Hata yanıtları şu formattadır:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "İnsan tarafından okunabilir hata mesajı",
    "details": {}
  }
}

Başlangıç

1. Brokerage platformundan API kimlik bilgilerini alın
2. /auth/authenticate endpoint'ini kullanarak kimlik doğrulayın
3. Sonraki isteklerde Authorization header'ında access token'ı kullanın
4. Token süresi dolduğunda /auth/refresh endpoint'ini kullanarak token'ı yenileyin