- App ID ve Organizasyon Kimliği genel tanımlayıcılardır; istemci taraflı kodda ve SDK başlatmada güvenle kullanılabilir.
- Uygulama API Anahtarı ve Organizasyon API Anahtarı özel sırlardır. Güvenli bir şekilde saklayın ve istemci taraflı kodda asla açığa çıkarmayın.
App ID
App ID, 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
App ID’nizi 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 > Organizasyonunuz > Keys & IDs altında veya Bir uygulamayı görüntüle API’si aracılığıyla bulabilirsiniz.
API anahtarları
İki tür API anahtarı vardır. Her ikisi de REST API isteklerinin kimliğini doğrular ve gizli tutulmalıdır. Yapmak istediğiniz işleme uygun olanı seçin:| Anahtar | Kullanım amacı |
|---|---|
| Uygulama API Anahtarı | Tek bir belirli uygulama: mesaj gönderme, kullanıcı oluşturma, istatistik okuma. |
| Organizasyon API Anahtarı | Tüm organizasyonunuz genelinde: uygulama oluşturma ve diğer API anahtarlarını yönetme. |
Uygulama başına en fazla 16 Uygulama API Anahtarı ve organizasyon başına en fazla 16 Organizasyon API Anahtarı oluşturabilirsiniz.
Uygulama API anahtarı
Tek bir uygulamayla sınırlı her türlü REST API isteği için Uygulama API Anahtarı kullanın: mesaj gönderme, kullanıcı oluşturma veya güncelleme veya mesaj geçmişini okuma gibi. Pano, mevcut API anahtarı değerlerini hiçbir zaman göstermez. Anahtar Kimliği (Key ID) sütunundaki dize yalnızca dahili bir tanımlayıcıdır, anahtar değildir. Yeniden çalışan bir sır elde etmek için aşağıdaki adımları izleyerek yeni bir API anahtarı oluşturun veya mevcut bir anahtarı döndürün. Döndürme aynı Anahtar Kimliğini, adı ve IP izin listesini korurken yeni bir değer üretir ve eski değer anında çalışmayı durdurur.
Uygulamanın Settings > Keys & IDs bölümüne gidin
OneSignal panosunda uygulamanızı seçin ve Settings > Keys & IDs bölümüne gidin.
Add Key'e tıklayın
Açıklayıcı bir ad girin (örneğin
Backend service). İsteğe bağlı olarak, anahtarın yalnızca onaylanmış sunuculardan çalışmasını sağlamak için bir IP izin listesi ekleyin.
Organizasyon API anahtarı
Organizasyon API Anahtarını organizasyonunuzdaki tüm uygulamaları kapsayan işlemler için kullanın. Yaygın uç noktalar:- Uygulama yönetimi: Uygulama oluştur, Uygulamaları görüntüle
- API anahtarı yönetimi: API anahtarı oluştur, API anahtarını sil, API anahtarını döndür
Organizasyonun Keys & IDs bölümüne gidin
OneSignal panosunda Organizations > Organizasyonunuz > Keys & IDs bölümüne gidin.
Add Key'e tıklayın ve adlandırın
Açıklayıcı bir ad girin (örneğin
App provisioning). İsteğe bağlı olarak bir IP izin listesi ekleyin.
IP izin listesi
IP izin listesi isteğe bağlıdır ancak şiddetle önerilir. API anahtarı kullanımını belirli IP adresleriyle sınırlayarak sızdırılmış bir anahtarın başka bir yerden kullanılmasını engeller.- Boşlukla ayrılmış CIDR blokları girin (örnek:
192.0.2.0/24 192.0.2.123/32). - İzin verilmeyen IP’lerden gelen istekler reddedilir.
- Statik IP’lere sahip arka uç hizmetleri.
- Yüksek güvenlikli üretim ortamları.
API anahtarlarını yönetme
Bir anahtar oluşturduktan sonra, Settings > Keys & IDs içindeki anahtar listesinden düzenleyebilir, döndürebilir veya silebilirsiniz. Uygulama API anahtarları bu işlemleri REST API üzerinden de destekler. Organizasyon API anahtarları yalnızca pano üzerinden yönetilir.Anahtar düzenleme
Gizli değeri değiştirmeden adı veya IP izin listesini güncelleyin. Entegrasyon değişikliği gerekmez. Panoyu veya API anahtarını güncelle API’sini kullanın (yalnızca Uygulama API anahtarları).Anahtar döndürme
Döndürme, aynı Anahtar Kimliğini, adı ve IP izin listesini korurken yeni bir sır oluşturur. Eski sır anında çalışmayı durdurur. Aşağıdaki durumlarda bir anahtarı döndürün:- Anahtar açığa çıktığında.
- Erişimi olan bir ekip üyesi ayrıldığında.
- Rutin bir güvenlik döndürme zamanı geldiğinde.
- Orijinal anahtar değerini kaybettiğinizde ve çalışan bir sıra ihtiyacınız olduğunda.
Anahtar silme
Silme, anahtarı kalıcı olarak kaldırır ve bu anahtarı kullanan API erişimini anında engeller. Bir anahtar artık gerekli olmadığında silmeyi kullanın. Panoyu veya API anahtarını sil API’sini kullanın (yalnızca Uygulama API anahtarları).Eski API anahtarlarından geçiş
OneSignal, adlandırma, döndürme ve IP izin listesi ile birlikte Uygulama ve Organizasyon API anahtarlarını 2024 yılının Kasım ayında tanıttı. Eski User Auth anahtarı ve orijinal REST API anahtarı hâlâ kabul edilir, ancak bunlara ait yönetim arayüzü kaldırılmıştır ve yeni anahtarlar oluşturulamaz.Yeni anahtar oluşturun
Değiştirdiğiniz eski anahtara göre yeni bir Uygulama API Anahtarı veya Organizasyon API Anahtarı oluşturun.
Kodunuzu güncelleyin
OneSignal’a karşı kimlik doğrulayan her hizmette eski anahtarı yeni değerle değiştirin.
API temel URL'sini güncelleyin
API temel URL’nizi
https://onesignal.com/api/v1/ adresinden https://api.onesignal.com adresine değiştirin.Üretim ortamında eski anahtarınızı devre dışı bırakmadan önce API isteklerini hazırlık ortamında doğrulayın.
API erişimini engelleme
Bir anahtarı anında iptal etmek için Settings > Keys & IDs içinde döndürün veya silin. Eski değeri kullanan istekler anında başarısız olur. Mesaj göndermeyi durdurmak veya bir uygulamayı tamamen duraklatmak için Devre Dışı Bırakılmış Uygulamalar ve Organizasyonlar sayfasına bakın.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.
Sıkça sorulan sorular
API anahtarımı nasıl bulabilirim?
API anahtar değerlerios_v2_app_ ile başlar ve yalnızca anahtarı oluşturduğunuz veya döndürdüğünüz anda bir kez gösterilir. Panodaki Anahtar Kimliği (Key ID) sütunu dahili bir tanımlayıcıdır, API anahtarı değildir ve kimlik doğrulama için kullanılırsa 401 Unauthorized döndürür. Anahtar değerinizi kaydetmediyseniz, yeni bir değer oluşturmak için anahtarı döndürün. Tüm akış için Uygulama API Anahtarı veya Organizasyon API Anahtarı bölümüne bakın.
Eski bir Uygulama API anahtarını geri alabilir miyim?
Hayır. OneSignal artık eski Uygulama API anahtarlarını göstermez. Değeri kod tabanınızda bulamıyorsanız, yeni bir Uygulama API Anahtarı oluşturun ve entegrasyonlarınızı güncelleyin.App ID, Uygulama API Anahtarı ve Organizasyon API Anahtarı arasındaki fark nedir?
- App ID: Uygulamanız için genel bir tanımlayıcı. SDK kurulumunda ve uygulamayı belirtmek için API isteklerinde kullanılır.
- Uygulama API Anahtarı: Tek bir uygulama için mesaj göndermek ve kullanıcıları yönetmek için kullanılan gizli bir anahtar.
- Organizasyon API Anahtarı: Hesabınızdaki tüm uygulamaları ve organizasyon düzeyindeki ayarları yönetmek için kullanılan gizli bir anahtar.
API anahtarım açığa çıkarsa ne olur?
Hemen anahtarı döndürün. Döndürme, eski değeri geçersiz kılar ve aynı Anahtar Kimliğini, adı ve IP izin listesini korurken yeni bir değer yayınlar. Ardından anahtarı kullanan her hizmeti güncelleyin. Beklenmeyen API etkinliklerini görmek için denetim günlüklerinizi inceleyin.İlgili sayfalar
REST API genel bakış
İstekleri kimlik doğrulayın ve OneSignal REST API’yi anlayın.
Hız limitleri
Anahtar başına hız limitleri ve yüksek hacimli entegrasyonlar için en iyi uygulamalar.
Denetim günlükleri
API ve pano etkinliklerini anahtar, kullanıcı ve zamana göre inceleyin.
Devre Dışı Bırakılmış Uygulamalar ve Organizasyonlar
Bir uygulamayı duraklatın veya kapatın ve faturalandırma etkilerini anlayın.