Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt

Use this file to discover all available pages before exploring further.

API v1 kullanımdan kaldırılmıştır. Çalışmaya devam etmektedir ancak gelecekteki bir sürümde kaldırılacaktır. Tam uç nokta kümesine, gelişmiş kimlik doğrulamaya, profil yönetimine ve fatura işlemlerine erişmek için v2’ye geçin.

Değişenler

API v2, sürümlü bir URL yapısı, yeni uç nokta grupları ve mevcut API anahtarı yönteminin yanı sıra isteğe bağlı Bearer belirteci kimlik doğrulama akışı sunar.
Alanv1v2
Temel yol/customer/v1//customer/v2/
Kimlik doğrulama — API anahtarıX-ORBIT-KEY: <key> başlığıAynı — değişmedi
Kimlik doğrulama — Bearer belirteciDesteklenmiyorAuthorization: Bearer <token>
Lisans uç noktaları/customer/v1/licenses/.../customer/v2/licenses/...
IP beyaz listesiDüz uç noktalar/licenses/{id}/ips altında iç içe
API anahtarı yönetimiMevcut değil/customer/v2/api-keys/...
ProfilMevcut değil/customer/v2/profile/...
FaturalarMevcut değil/customer/v2/invoices/...

Kimlik doğrulama — değişiklik gerekmez

X-ORBIT-KEY başlığıyla kimlik doğruluyorsanız, kimlik doğrulama için hiçbir değişiklik gerekmez. Aynı anahtar v2 ile çalışır.
# v1 ve v2 ile çalışır
curl -H "X-ORBIT-KEY: YOUR_API_KEY" https://api.orbitflare.com/customer/v2/licenses
İsteğe bağlı olarak, güvenliği artırmak için Bearer belirteci kimlik doğrulamasına (cihaz akışı veya cüzdan imzası) geçebilirsiniz. Ayrıntılar için Kimlik doğrulama uç noktalarına bakın.

Uç nokta eşlemesi

Lisanslar

v1 uç noktasıv2 karşılığı
GET /customer/v1/licensesGET /customer/v2/licenses
GET /customer/v1/licenses/{id}GET /customer/v2/licenses/{id}
POST /customer/v1/licenses/{id}/reset-keyPOST /customer/v2/licenses/{id}/reset-key
POST /customer/v1/licenses/{id}/regenerate-keyPOST /customer/v2/licenses/{id}/regenerate-key
GET /customer/v1/locationsGET /customer/v2/licenses/locations
GET /customer/v1/licenses/{id}/ipsGET /customer/v2/licenses/{id}/ips
POST /customer/v1/licenses/{id}/ipsPOST /customer/v2/licenses/{id}/ips
DELETE /customer/v1/licenses/{id}/ips/{ip}DELETE /customer/v2/licenses/{id}/ips/{ip}

Yalnızca v2’de yeniler

Bu uç noktalar v1’de yoktur ve yalnızca v2’de kullanılabilir:
Uç noktaAçıklama
POST /customer/v2/auth/device/codeCihaz yetkilendirme akışını başlatır
POST /customer/v2/auth/device/tokenCihaz kodunu erişim belirteciyle takas eder
POST /customer/v2/auth/wallet/challengeCüzdan imzası meydan okuması ister
POST /customer/v2/auth/wallet/verifyCüzdan imzasını doğrular ve belirteç döner
GET /customer/v2/api-keysTüm API anahtarlarını listeler
POST /customer/v2/api-keysYeni API anahtarı oluşturur
PATCH /customer/v2/api-keys/{id}Bir API anahtarını günceller
DELETE /customer/v2/api-keys/{id}Bir API anahtarını siler
GET /customer/v2/profileKullanıcı profilini döndürür
PATCH /customer/v2/profileKullanıcı profilini günceller
GET /customer/v2/profile/balanceHesap bakiyesini döndürür
GET /customer/v2/invoicesFaturaları listeler
GET /customer/v2/invoices/{id}Belirli bir faturayı döndürür
POST /customer/v2/invoices/{id}/payFaturayı hesap bakiyesiyle öder

Geçiş adımları

1

Temel URL'nizi güncelleyin

İstemcinizdeki yol önekini /customer/v1/ yerine /customer/v2/ yapın:
# Önce
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v1/licenses

# Sonra
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v2/licenses
2

Konumlar uç noktasını güncelleyin

Konumlar uç noktası üst düzey yoldan lisanslar grubuna taşındı:
# Önce
GET /customer/v1/locations

# Sonra
GET /customer/v2/licenses/locations
3

Entegrasyonunuzu test edin

Mevcut entegrasyonunuzu v2 uç noktalarına karşı çalıştırın. Paylaşılan uç noktalar (lisanslar, IP’ler) için yanıt gövdeleri geriye dönük uyumludur. Taşınan uç noktalar için yanıt ayrıştırma değişikliği gerekmez.
4

(İsteğe bağlı) Kimlik doğrulamayı yükseltin

API anahtarları yerine Bearer belirteci kullanmak istiyorsanız cihaz yetkilendirme akışını veya cüzdan imzası akışını uygulayın.

Yardıma mı ihtiyacınız var?

Geçiş sırasında sorun yaşarsanız Discord üzerinden ulaşın veya support@orbitflare.com adresine yazın.