OneSignal App ID, Organization ID ve API anahtarlarınızı bulun ve yönetin. Anahtarları nasıl oluşturacağınızı, döndüreceğinizi, güvence altına alacağınızı ve güvenli bir şekilde taşıyacağınızı öğrenin.
OneSignal hesabınız, genel kimlikler (App ID, Organization ID) ve özel API anahtarları (Uygulama API anahtarı, Organizasyon API anahtarı) içerir.
App ID ve Organizasyon Kimliği genel tanımlayıcılardır; istemci taraflı kodda ve SDK başlatmada güvenle kullanılabilir.
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:
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.
Pano, API anahtarı değerini değil, Anahtar Kimliğini gösterir. Gerçek değer (os_v2_app_ ile başlayan) yalnızca anahtar oluşturulduğunda veya döndürüldüğünde bir kez gösterilir.
Uygulama API Anahtarı oluşturmaPanoda bir Uygulama API Anahtarı oluşturmak için aşağıdaki adımları izleyin veya API anahtarı oluştur API’sini kullanı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.
3
Create'e tıklayın, ardından anahtar değerini hemen kopyalayın
Değer os_v2_app_ ile başlar ve yalnızca bir kez gösterilir. Hemen bir sır yöneticisine veya arka uç ortam değişkenine kaydedin.
Oluşturulan API anahtarı değeri, yalnızca bir kez gösterilir
Uygulama API Anahtarlarını parola gibi değerlendirin:
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ı oluşturma:Organizasyon API anahtarları yalnızca pano üzerinden oluşturulur. Bunları oluşturmak için bir API uç noktası yoktur.
Açıklayıcı bir ad girin (örneğin App provisioning). İsteğe bağlı olarak bir IP izin listesi ekleyin.
3
Create'e tıklayın, ardından anahtar değerini hemen kopyalayın
Değer os_v2_app_ ile başlar ve yalnızca bir kez gösterilir. Hemen güvenli bir şekilde saklayın.
Organizasyon API Anahtarlarının oluşturulduğu organizasyon Keys & IDs sayfası
Organizasyon API Anahtarları, organizasyonunuzdaki tüm uygulamalara erişim sağlar. Onlara ekstra özen gösterin ve yalnızca organizasyon çapında erişime gerçekten ihtiyaç duyan hizmetlerle paylaşın.
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.
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.
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ı).
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.
Bir anahtarı döndürdükten sonra, eski değeri kullanan tüm hizmetleri güncelleyin. Eski anahtarla yapılan istekler anında başarısız olur.
Panoyu veya API anahtarını döndür API’sini kullanın (yalnızca Uygulama API anahtarları).
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ı).
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.
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.
API anahtar değerleri os_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.
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.
