API Anahtarları — tnea_ ve tnsr_¶
NumerologyAPI iki aile API anahtarı kullanır. Her ikisi de benzer görünür, aynı 80 karakterlik güvenli formatla oluşturulur ve aynı X-API-Key başlığıyla kimlik doğrulaması yapar — ancak farklı şekilde ölçülürler ve farklı ürünler için tasarlanmıştır.
| Ön ek | Tür | Kullanım amacı | Ölçüm |
|---|---|---|---|
tnea_ | Platform anahtarı | Web uygulamaları, mobil arka uçlar, sunucu entegrasyonları | Kuruluş kredi cüzdanı (kullandıkça öde) |
tnsr_ | Numora Studio anahtarı | Numora Studio masaüstü uygulaması | Kuruluş Numora Studio plan kontenjanı |
1. Anahtar Formatı ve Güvenlik¶
Her anahtar tam olarak 80 karakter uzunluğundadır:
tnea_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tnsr_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- 4 karakterlik ön ek anahtar türünü belirler; kalan 75 karakter kriptografik olarak güvenli rastgele bir kaynaktan üretilir.
- Anahtarlar sunucu tarafında SHA-256 ile hashlenmiş olarak saklanır. Düz metin anahtar yalnızca bir kez, oluşturma anında gösterilir.
- Bir anahtar herhangi bir şekilde ifşa olursa, panelden hemen döndürün.
2. Platform Anahtarları (tnea_)¶
Platform anahtarları, NumerologyAPI'yi kendi ürününüze — web siteleri, mobil uygulamalar ve sunucu tarafı hizmetler — entegre etmek için standart anahtarlardır.
Kimlik Doğrulama¶
Anahtarı her istekte X-API-Key başlığıyla gönderin:
curl --request GET \
--url "https://api.numerologyapi.com/api/v1/life_path?birth_year=1990&birth_month=5&birth_day=15" \
--header "x-api-key: tnea_YOUR_API_KEY"
Ölçüm¶
Faturalandırılabilir /api/v1 çağrıları, kuruluşunuzun kredi cüzdanından (kullandıkça öde) düşülür. Cüzdanı istediğiniz zaman panelden doldurabilirsiniz.
Kanal kuralı: platform anahtarları
X-Numora-Clientbaşlığını göndermemelidir. Gönderilmesi403döndürür — bu başlık masaüstü kanalına ayrılmıştır.
3. Numora Studio Anahtarları (tnsr_)¶
Numora Studio anahtarları, uygulayıcıların müşteri raporları oluşturmak için kullandığı Numora Studio masaüstü uygulamasının (macOS/Windows) kimliğini doğrular. Aynı formata sahip platform anahtarlarının bir kardeşi olan bu anahtarlar, platform kredileri yerine kuruluşun Numora Studio plan kontenjanı üzerinden faturalandırılır.
Sağlama¶
Bir tnsr_ anahtarı iki şekilde oluşturulur:
- masaüstü uygulama oturum açma akışı aracılığıyla (tarayıcı onay sayfası anahtarı otomatik olarak sağlar) veya
- paneldeki API Anahtarları sayfasında (
/api-keys) manuel olarak.
Kanal imzası (zorunlu)¶
Bir tnsr_ anahtarıyla yapılan her çağrı, masaüstü kanal başlığını içermelidir:
| Başlık | Değer | Gerekli |
|---|---|---|
X-Numora-Client | numora-studio/<version> | Evet, tüm çağrılarda |
X-API-Key | sizin tnsr_ anahtarınız | Evet |
X-Numora-Device-Id | kayıtlı cihaz kimliği | Yalnızca anahtarda cihaz kilitleme etkinleştirildiğinde |
Sunucu tarafı zorunluluğu:
X-Numora-Clientolmadantnsr_anahtarı →403.X-Numora-Clientiletnea_anahtarı →403.
Ölçüm¶
- Faturalandırılabilir
/api/v1çağrıları, kuruluşun Numora Studio plan kontenjanından düşülür (kuruluşun tümtnsr_anahtarları arasında paylaşılan tek bir havuz). - Her
tnsr_anahtarı için bir kredi yedeği seçeneği vardır: plan kontenjanı tükendiğinde, anahtar kuruluşun platform kredilerine düşebilir (varsayılan olarak kapalı). - Kontenjan tükenmişse ve hiçbir yedek etkin değilse, çağrılar
429döndürür.
Cihaz kilitleme (isteğe bağlı)¶
Bir tnsr_ anahtarı kayıtlı cihazlara kilitlenebilir. Kilitleme etkinken, her istek kuruluşa kayıtlı bir X-Numora-Device-Id taşımalıdır; kayıtlı olmayan cihazlar 403 ile reddedilir.
Yalnızca masaüstüne özel uç noktalar¶
Bazı uç noktalar masaüstü kanalına ayrılmıştır ve tnea_ anahtarları için 403 döndürür:
POST /api/v1/numora/report-bundle— tek çağrıda tam müşteri raporuPOST /api/v1/numora/order— uygulama içi plan/kontenjan satın alma akışıPOST /api/v1/numora/devices/register— bir masaüstü kurulumunu kaydetmeGET /api/v1/numora/studio-status— masaüstü bakiyeleri ve kota sayaçları
İpucu: faturalandırılabilir yanıtlar ayrıca
X-Remaining-CreditsveX-Remaining-Tokensbaşlıklarını taşır; böylece ek çağrı yapmadan canlı bakiyeleri takip edebilirsiniz.
4. Anahtarları Yönetme (Panel)¶
Paneldeki API Anahtarları sayfası (/api-keys), her iki anahtar türü için de kontrol merkezidir.
| İşlem | Açıklama |
|---|---|
| Oluştur | Yeni bir tnea_ veya tnsr_ anahtarı oluşturun |
| Döndür | Geçerli anahtarı iptal edin ve aynısının yerine yenisini verin |
| İptal et | Bir anahtarı hemen devre dışı bırakın |
| Kredi yedeği | Her tnsr_ anahtarı için kredi yedeğini açıp kapatın |
| Cihaz kilitleme | Bir tnsr_ anahtarını kayıtlı cihazlara kilitleyin |
| Cihazlar | Kayıtlı masaüstü kurulumlarını görüntüleyin ve yönetin |
Roller: admin ve developer rolleri anahtar oluşturabilir ve yönetebilir. finance rolü üretim API anahtarları oluşturamaz. Finansal işlemler (plan satın alma, bakiye yükleme) yalnızca admin ve finance rolleriyle sınırlıdır.
Birden çok anahtar: kuruluşlar her iki türden de birçok anahtar tutabilir — örneğin her uygulayıcı veya masaüstü kurulumu için bir tnsr_ anahtarı. Kontenjanlar kuruluş genelinde paylaşılır; bu nedenle anahtarlar kendi bakiyeleri için asla "rekabet etmez".
5. En İyi Uygulamalar¶
- Anahtarlara şifre gibi davranın. Bunları asla istemci tarafı kodlara, herkese açık depolara veya günlüklere gömmeyin.
- Arka uçta ortam değişkenleri veya bir sır yöneticisi kullanın.
- Bir anahtar tehlikeye girerse veya bir ekip üyesi ayrılırsa hemen döndürün.
- Cihaz yönetimini ve iptali basitleştirmek için her masaüstü kurulumu için bir
tnsr_anahtarı kullanın. - Yüksek güvenlikli kuruluşlar için cihaz kilitlemeyi etkinleştirin.
- Beklenmeyen artışları erken yakalamak için panelde kullanımı izleyin.
6. Sık Sorulan Sorular¶
Bir tnsr_ anahtarı normal platform uç noktalarını çağırabilir mi? Evet. Numora Studio anahtarları tüm /api/v1 yüzeyinin kimliğini doğrular; bu çağrılar Numora Studio plan kontenjanı üzerinden faturalandırılır.
Bir tnea_ anahtarı yalnızca masaüstüne özel /numora/* uç noktalarını çağırabilir mi? Hayır. Yalnızca masaüstüne özel uç noktalar, platform anahtarları için 403 döndürür.
tnsr_ anahtarımla çağrı yaparken neden 403 alıyorum? Büyük olasılıkla X-Numora-Client başlığı eksiktir veya uygulama kimliği eşleşmiyor. Her isteğin X-Numora-Client: numora-studio/<version> içerdiğini kontrol edin.
tnea_ anahtarımla neden 403 alıyorum? Platform anahtarları X-Numora-Client başlığını taşımamalıdır — kaldırın.
Kontenjanım tükenirse ne olur? Faturalandırılabilir çağrılar, tnsr_ anahtarınızda kredi yedeği etkinleştirilmedikçe (veya tnea_ anahtarları için platform cüzdanınızı doldurmadıkça) 429 döndürür.