Skip to main content
Developer Hub’da bir hizmet hesabı ve bir API anahtarı oluşturun, ardından ilk isteğinizi gönderin. Bu hızlı başlangıç kılavuzu API anahtarı ile kimlik doğrulamayı kullanır; bir OAuth istemcisine ihtiyacınız yoktur. Entegrasyonunuz kısa ömürlü OAuth erişim belirteçleri gerektiriyorsa Kimlik Doğrulama sayfasına bakın.

Ön koşullar

  • Living Security Kontrol Paneli’ne yönetici erişimi.
  • Ayarlar → Entegrasyonlar ve Geliştiriciler → Developer Hub altında görünen Developer Hub.

Kimlik bilgilerini oluşturma

1

Hizmet hesabı oluşturun

Developer Hub’da Service accounts sekmesini açın ve bir hesap oluşturun. Hesaba açıklayıcı bir ad verin (örneğin reporting-pipeline) ve anahtarlarının kullanabileceği izinleri tanımlayın — bu kılavuz için organization:read yeterlidir.Hesabın izinleri, bu hesap altında oluşturulan her anahtar için üst sınırdır: bir anahtar, hizmet hesabının izin verdiğinden fazlasını asla yapamaz.
2

API anahtarı oluşturun

Hizmet hesabının ayrıntı sayfasını açın ve bir anahtar oluşturun. Bu anahtar için gereken izinleri (hesabın izinlerinin bir alt kümesi) ve bir son kullanma süresi seçin — 30, 90 veya 365 gün ya da özel bir süre. Son kullanma süresi zorunludur.Anahtarın gizli değeri lsk_live_ ile başlar ve yalnızca bir kez gösterilir. Hemen bir gizli anahtar yöneticisine kopyalayın; daha sonra tekrar alınamaz.
API anahtarı gizli değerlerini asla sürüm kontrolüne eklemeyin veya istemci tarafı koda gömmeyin. Gizli değere sahip olan herkes, anahtarın izinleriyle işlem yapabilir.
3

Bölgenizi seçin

Kuruluşun veri yerleşimine uygun bölgesel /v1 ana bilgisayarını çağırın. Anahtarlar yalnızca bu ana bilgisayarda kimlik doğrular.Hangi ana bilgisayarı kullanacağınızdan emin değilseniz Bölgeler sayfasına bakın. Diğer bölgeye gönderilen geçerli bir anahtar unauthorized hatasıyla başarısız olur. Ana bilgisayarı değiştirmek için aşağıdaki örnekte bulunan bölge açılır menüsünü kullanın.
4

İlk isteğinizi gönderin

LIVING_SECURITY_API_KEY değerini gizli anahtar yöneticinizden, isteği yapan sürecin ortamına yükleyin. Aşağıdaki örnekler bu değeri kaynak koda gizli değer gömmeden okur. Python için önce requests paketini yükleyin.API’yi, gizli değeri HTTP Basic kimlik doğrulamasının parola veya kullanıcı adı alanında kullanarak çağırın — ikisi de çalışır; bu nedenle her iki alanın da doldurulmasını gerektiren istemciler (Power BI’ın Web bağlayıcısı gibi) diğer alana apikey gibi bir yer tutucu girebilir.
Başarılı bir yanıt kuruluşunuzu döndürür:
Response
Bu yanıtı alırsanız kimlik bilgileriniz çalışıyordur. İstek ayrıca kısa süre içinde Developer Hub’ın Request logs sekmesinde görünür.
Aynı gizli değerle Bearer kimlik doğrulaması (Authorization: Bearer lsk_live_...) da çalışır. Basic kimlik doğrulaması, yalnızca kullanıcı adı/parola kullanan araçların — Power BI’ın Web bağlayıcısı gibi — bağlanabilmesi için vardır.

Kimlik doğrulama nasıl çalışır

  • Kimlik bilgisi kuruluşu belirler. /v1 istekleri kiracı seçici taşımaz: kuruluş yol segmenti ve kuruluş üst bilgisi yoktur. x-organization-id üst bilgisi göndermek invalid_request ile reddedilir. Ana bilgisayar yine de kuruluşun bölgesiyle eşleşmelidir. Bkz. Bölgeler.
  • İzinler işlem bazında kontrol edilir. Her /v1 işlemi adlandırılmış bir izin gerektirir (örneğin GET /v1/organization için organization:read gerekir). İzni olmayan bir anahtar, insufficient_permission koduyla 403 alır.
  • Anahtarların süresi dolar ve kesinti olmadan yenilenebilir. Çakışma penceresiyle anahtar yenileme için API anahtarları sayfasına bakın.

Hata yanıtlarını okuma

Her /v1 hatası, kararlı bir makine koduyla birlikte application/problem+json biçimindedir (RFC 9457). Örneğin, kimlik bilgisi eksik veya bilinmeyen bir istek şu yanıtı döndürür:
401 Unauthorized
İşlem akışınızı code değerine göre dallandırın, asla detail değerine göre değil. Çözüm adımları için doc_url bağlantısını izleyin ve destekle iletişime geçerken request_id değerini ekleyin — bu değer Request-Id yanıt üst bilgisi ve Developer Hub istek günlükleriyle eşleşir. Kodların tam listesi hata başvurusunda yer alır.

Sözleşme sürümleri

Her yanıt, isteği karşılayan sözleşme sürümünü Living-Security-Version üst bilgisinde, ilişkilendirme için kullanılan Request-Id üst bilgisiyle birlikte döndürür. Bir isteği, yayımlanmış bir sözleşme sürümüne tarih belirterek sabitleyebilirsiniz:
Sürüm şu sırayla belirlenir: varsa istek üst bilgisi, yoksa hizmet hesabının sabitlenmiş varsayılanı, o da yoksa yayımlanmış en son sürüm. Yayımlanmamış (veya sonlandırma tarihi geçmiş) bir sürüm istemek, unsupported_version koduyla 400 döndürür. Yayımlanmış sürümler ve değişiklikleri API değişiklik günlüğünde listelenir.

İlk isteğinizde sorun giderme

Diğer hatalar için yanıttaki doc_url bağlantısını izleyin. Request-Id değerini destek için saklayın; bir destek talebine asla Authorization üst bilgisini veya API anahtarınızı eklemeyin.

Sonraki adımlar

Bölgeler

Kuruluş için US veya EU /v1 ana bilgisayarını seçin.

Sayfalama

Listelerde page_token ve liste zarfı ile gezinin.

Hız sınırları

İstek bütçelerini anlayın ve 429 yanıtlarını yönetin.

Hata başvurusu

Tüm hata kodları, HTTP durumları ve nasıl çözüleceği.

Developer Hub

Hizmet hesaplarını, API anahtarlarını ve istek günlüklerini yönetin.