Ana içeriğe atla
OneSignal hesabınız genel kimlikler ve özel API anahtarları içerir.
  • Uygulamalarınızı yapılandırmak ve referans vermek için kimlikleri (Uygulama Kimliği gibi) kullanın.
  • Güvenli REST API isteklerini doğrulamak için API anahtarlarını kullanın.
Bu kılavuz, her anahtarın ne işe yaradığını, nerede bulacağınızı ve güvenli bir şekilde nasıl yöneteceğinizi açıklar.

​
Uygulama Kimliği

Uygulama Kimliği, OneSignal uygulamanızı tanımlayan genel bir UUID (v4)‘tür. Şu amaçlarla kullanırsınız:
  • SDK başlatma (Mobil SDK kurulumu, Web SDK kurulumu)
  • Mesaj oluştur ve Kullanıcı oluştur gibi API istekleri yapma
Uygulama Kimliğinizi panoda Settings > Keys & IDs altında veya Uygulamaları görüntüle API’si aracılığıyla bulabilirsiniz.
Uygulama Kimliği konumunu gösteren OneSignal panosu Anahtarlar ve Kimlikler sayfası.

Uygulama Kimliğinizi istemci taraflı SDK başlatmada güvenle kullanabilirsiniz. Gizli bir değer değildir.

​
Organizasyon Kimliği

Organizasyon Kimliği (Org ID), faturalama planınız altındaki tüm uygulamaları gruplandıran bir UUID (v4)‘tür. Aşağıdaki gibi Organizasyon düzeyindeki API’ler için gereklidir: Organizations > Your Organization > Keys & IDs altında veya Bir uygulamayı görüntüle API’si aracılığıyla bulabilirsiniz.
OneSignal panosunda Anahtarlar ve Kimlikler altında Organizasyon Kimliğini gösterme.

​
API anahtarlarına genel bakış

OneSignal iki tür API anahtarını destekler:
Anahtar TürüKapsamKullanım Amacı
Uygulama API AnahtarıTek uygulamaMesaj gönderme, kullanıcı oluşturma, uygulama düzeyinde işlemler
Organizasyon API AnahtarıTüm organizasyonUygulama oluşturma, API anahtarı yönetimi, organizasyon düzeyinde yapılandırma
16’ya kadar API anahtarı oluşturabilir ve IP izin listesi yapılandırabilirsiniz.
Her ikisi de özel sırlardır ve güvenli bir şekilde saklanmalıdır.

​
Uygulama API anahtarı

Belirli bir uygulamayla ilgili çoğu REST API isteği için Uygulama API Anahtarı kullanın. Kimlik doğrulama formatı: Anahtarı Authorization başlığına key kimlik doğrulama şemasıyla ekleyin: 
Authorization: key YOUR_REST_API_KEY
Uygulama API Anahtarlarını App Settings > Keys & IDs bölümünden veya API anahtarı oluştur API’si aracılığıyla oluşturabilirsiniz.
Uygulama API Anahtarlarına şifre gibi davranın.
  • Asla mobil veya web istemci kodunda açığa çıkarmayın.
  • Asla genel depolara (GitHub gibi) kaydetmeyin.
  • Güvenli bir arka uçta veya sır yöneticisinde saklayın.

​
Organizasyon API anahtarı

Organizasyon API Anahtarını şu amaçlarla kullanın: OneSignal panosunda Organizations > Your Organization > Keys & IDs bölümünden oluşturun.
Uygulama API anahtarlarında olduğu gibi, 16’ya kadar organizasyon anahtarı yapılandırabilir ve IP izin listesi yapılandırmasını dahil edebilirsiniz.

​
API anahtarları oluşturma

Hem Uygulama hem de Organizasyon API anahtarlarını panodan oluşturabilirsiniz.
  • Uygulama API anahtarları ayrıca API anahtarı oluştur API’si aracılığıyla da oluşturulabilir.
  • Organizasyon API anahtarları yalnızca pano üzerinden oluşturulabilir.
Anahtar oluşturma:
  1. Keys & IDs bölümüne gidin (Uygulama veya Organizasyon düzeyinde).
  2. Add Key’e tıklayın.
OneSignal panosunda yeni API anahtarı oluşturma penceresi.
  1. Açıklayıcı bir ad girin (örnek: CRM Senkronizasyon Hizmeti).
  2. (İsteğe bağlı) IP izin listesini yapılandırın.
  3. Create’e tıklayın.
  4. Anahtarı hemen kopyalayın ve güvenli bir şekilde saklayın.
API anahtarları yalnızca bir kez gösterilir. Anahtarı kaybederseniz döndürmeniz gerekir.

​
IP izin listesi (isteğe bağlı ancak önerilir)

API anahtarı kullanımını belirli IP adreslerine kısıtlayabilirsiniz.
  • Boşlukla ayrılmış CIDR blokları girin
    • Örnek: 192.0.2.0/24 192.0.2.123/32
  • İzin verilmeyen IP’lerden gelen istekler reddedilecektir.
IP izin listesini şu durumlarda kullanın:
  • Statik IP’lere sahip arka uç hizmetleri
  • Yüksek güvenlikli üretim ortamları
API anahtarı oluşturma penceresindeki IP izin listesi yapılandırma alanı.

​
Anahtar yönetimi

Bir anahtar oluşturduktan sonra, anahtar listesi arayüzü aracılığıyla yönetebilirsiniz:
OneSignal panosunda anahtar adlarını ve kimliklerini gösteren API anahtar listesi.
Anahtar Kimliği referans için bir etikettir. Gizli API anahtarı değildir.

​
API anahtarlarını düzenleme

Şunları yapabilirsiniz:
  • Anahtar adını güncelleme
  • IP izin listesi ayarlarını değiştirme
Düzenleme, gizli değeri değiştirmez. Entegrasyon değişikliği gerekmez.
  • Uygulama API anahtarları pano veya API anahtarını güncelle API’si aracılığıyla güncellenebilir.
  • Organizasyon API anahtarları yalnızca pano üzerinden güncellenebilir.

​
API anahtarlarını döndürme

Bir anahtarı döndürmek:
  • Yeni bir sır oluşturur
  • Aynı adı ve yapılandırmayı korur
  • Eski sırrı anında geçersiz kılar
Ne zaman döndürülmeli:
  • Anahtar açığa çıktığında
  • Erişimi olan bir ekip üyesi ayrıldığında
  • Rutin güvenlik döndürme
Bir anahtarı döndürdükten sonra, onu kullanan tüm hizmetleri güncelleyin. Eski anahtarla yapılan istekler başarısız olacaktır.
  • Uygulama API anahtarları pano veya API anahtarını döndür API’si aracılığıyla döndürülebilir.
  • Organizasyon API anahtarları yalnızca pano üzerinden döndürülebilir.

​
API anahtarlarını silme

Bir anahtarı silmek:
  • Kalıcı olarak kaldırır
  • Bu anahtarı kullanan API erişimini anında engeller
Bir anahtar artık gerekli olmadığında silme işlemini kullanın.
  • Uygulama API anahtarları pano veya API anahtarını sil API’si aracılığıyla silinebilir.
  • Organizasyon API anahtarları yalnızca pano üzerinden silinebilir.

​
Eski API anahtarlarından geçiş

14 Kasım 2024’te zengin API anahtarı yönetimini tanıttık. Geçiş Adımları
  1. Yeni bir Uygulama veya Organizasyon API anahtarı oluşturun.
  2. Kodunuzdaki eski anahtarı değiştirin.
  3. API temel URL’nizi şu şekilde güncelleyin:
https://api.onesignal.com
Şunun yerine: 
https://onesignal.com/api/v1/
  1. Keys & IDs bölümünden eski anahtarı devre dışı bırakın veya silin.
Üretim ortamında eski anahtarınızı devre dışı bırakmadan önce API isteklerini bir hazırlık ortamında test edin.

​
Uygulamanızı devre dışı bırakma

API erişimini engelleme:
  • REST API kullanımını anında engellemek için API anahtarlarını silin veya döndürün.
Mesaj göndermeyi devre dışı bırakma:
  • Settings > Manage App > Disable App bölümüne gidin.
Ayrıntılar için Devre Dışı Bırakılmış Uygulamalar ve Organizasyonlar sayfasına bakın.
Bir uygulamayı devre dışı bırakmak faturalandırmayı durdurmaz. Devre dışı bırakılmış uygulamaların Aylık Aktif Kullanıcıları (MAU) hâlâ faturalandırmaya dahil edilir.Faturalandırmayı durdurmak için uygulamayı silin veya Ücretsiz bir Organizasyona taşıyın.Yardım için support@onesignal.com ile iletişime geçin.

​
Güvenlik en iyi uygulamaları

  • API anahtarlarını güvenli bir arka uçta saklayın (asla istemci tarafında değil).
  • Ortam değişkenleri veya bir sır yöneticisi kullanın.
  • Mümkün olduğunda IP izin listesini etkinleştirin.
  • Anahtarları periyodik olarak döndürün.
  • Hazırlık ve üretim ortamları için ayrı anahtarlar kullanın.