Kimlik doğrulama

Her istek bir API anahtarıyla doğrulanır. Anahtarı Bearer belirteci olarak gönderin:

Authorization: Bearer gsk_live_xxx

Bearer belirteci ortamınızda zahmetliyse x-api-key: gsk_live_xxx başlığı da kabul edilir. Anahtarsız her istek title: invalid_key ile 401 alır.

Anahtar biçimi

gsk_live_<id>_<gizli> veya gsk_test_<id>_<gizli>. gsk_live anahtarı gerçek iş yapar ve ücretlendirilir. gsk_test anahtarı sandbox içinde çalışır: araçlar simüle edilir ve ücret alınmaz; bu anahtarla ilanlar, lead'ler ve diğer gerçek veriler değiştirilemez. Anahtar türü oluşturma sırasında seçilir.

Gizli kısım oluşturma sırasında yalnızca bir kez gösterilir. GREM yalnızca karmasını saklar, bu yüzden kaybolan bir anahtar geri getirilemez: yenisini oluşturun ve eskisini iptal edin.

Anahtar yönetimi

Panelde, API → Anahtarlar:

• Bir etiketle anahtar oluşturun. Gelişmiş ayarlar, kapsamları ve gün cinsinden bir süre sonunu seçmenizi sağlar. Seçim yapılmazsa anahtar tüm kapsamları alır.
• Yenileyin: yeni bir gizli kısım verilir; entegrasyonunuzda değiştirebilmeniz için eskisi 24 saat çalışmaya devam eder.
• İptal edin: anahtar hemen ve kalıcı olarak çalışmayı durdurur.

Anahtar durumu listede gösterilir: active, çalışıyor; suspended, API erişimi bir yönetici tarafından duraklatıldı (geri alınabilir, anahtar yok edilmez); revoked, iptal edildi. Süre sonu olan bir anahtar, süresi dolduktan sonra kabul edilmez (401).

Ajans anahtarları

Bir ajans sahibi veya yöneticisi ajans adına anahtar çıkarabilir: anahtar listesini ajans kapsamına geçirin. Böyle bir anahtar:

• kişisel değil, ajansın ilanlarını ve lead'lerini görür;
• ajansın ortak havuzundan lead alabilir ve geri verebilir (Lead'ler);
• ilanları ajansa taşıyabilir ve bir temsilci atayabilir (İlanlar).

Bir anahtar tek bir temsilciye bağlanabilir: o zaman o temsilci olarak, onun yetkileriyle çalışır.

Kapsamlar

Her anahtar bir kapsam kümesi taşır. Gerekli kapsam olmadan yapılan çağrı title: forbidden_scope ile 403 döndürür. Bir işlemin gerektirdiği kapsam, /openapi.json içindeki açıklamasında belirtilir (x-required-scope alanı).

Hiçbir kapsam olmadan GET /ping, GET /me, GET /dictionaries, GET /objects, GET /voices, GET /tools/status ve GET /works çağrılabilir.

Bu hangi anahtar

curl https://developers.grem.capital/api/v1/me \
  -H "Authorization: Bearer gsk_live_xxx"

GET /me anahtarın kimliğini ve önekini, kime ait olduğunu (subjectType: user veya agency, subjectId ve temsilci anahtarı için agencyMemberId), verilen kapsamları, tam bu anahtara uygulanan limitleri (dakikada rateLimit.rpm ve günde rateLimit.rpd) ve süre sonunu döndürür. Gizli kısım asla döndürülmez. Ücretsiz.

Güvenlik

• Anahtarları sunucu tarafındaki ortam değişkenlerinde veya bir gizli bilgi yöneticisinde tutun.
• Her entegrasyon için yalnızca gereken kapsamlara sahip ayrı bir anahtar kullanın: birini iptal etmek diğerlerini etkilemez.
• Anahtarları düzenli olarak yenileyin.
• İstekler yalnızca HTTPS üzerinden kabul edilir.

İlgili makaleler

• Hatalar: 401 ve 403 ayrıntılı olarak.
• Limitler ve ücretlendirme: rpm ve rpd ne anlama gelir.