Ana içeriğe atla
OneSignal hesabınız, uygulamalarınızı yapılandırmak ve OneSignal API’sine erişmek için gerekli olan hem genel kimlikler hem de özel API anahtarları içerir. Bu kılavuz, bunları nerede bulacağınızı, nasıl yöneteceğinizi ve güvenli kullanım için en iyi uygulamaları açıklar.

​
Uygulama Kimliği

Uygulama Kimliği, OneSignal projeniz için UUID v4 olarak biçimlendirilmiş benzersiz bir genel tanımlayıcıdır. Özel API anahtarlarınızdan farklıdır ve şunlar için gereklidir: Uygulama Kimliğinizi OneSignal Panosunda Settings > Keys & IDs altında veya Uygulamaları görüntüle API’si aracılığıyla bulun.

Uygulama Kimliğinizi ve Uygulama API anahtarlarınızı bulmak için Anahtarlar ve Kimlikler sayfası.


Uygulama Kimliğinizi nerede bulacağınıza dair örnek.

​
Organizasyon Kimliği

Organizasyon Kimliğiniz (Org ID), faturalama planınız altındaki tüm uygulamaları gruplandıran UUID v4 formatında benzersiz bir tanımlayıcıdır. Şunlarla ilgili API’ler için gereklidir: organization_id’nizi panoda Organizations > Your Organization altında veya Bir uygulamayı görüntüle API’si aracılığıyla bulabilirsiniz.

OneSignal panosunda Organizasyon Kimliğinizi nasıl bulacağınızı gösteren örnek.

​
API anahtarları

İki tür API anahtarı vardır:
  1. Uygulama API Anahtarları
  2. Organizasyon API Anahtarı – Bir Organizasyon içinde uygulamaları ve API anahtarlarını yapılandırmak için kullanılan özel bir anahtar.

​
Uygulama API anahtarı

Uygulama API anahtarınız, belirli bir uygulamayla ilgili çoğu REST API isteği için kullanılan özel bir anahtardır.
  • Uygulama API anahtarları Settings > Keys & IDs altında veya API Anahtarı Oluştur aracılığıyla oluşturulabilir.
  • Yalnızca oluşturulduktan sonra görüntülenebilirler.
  • Bu anahtarı Authorization başlığına key kimlik doğrulama şemasını kullanarak ekleyin: 
    Authorization: key YOUR_REST_API_KEY
Uygulama API Anahtarlarına bir şifre gibi davranın. Paylaşmayın, uygulama kodunuzda açığa çıkarmayın veya GitHub gibi genel depolarda saklamayın.

​
Organizasyon API anahtarı

Organizasyon API anahtarınız, bir Organizasyon içinde uygulamaları ve uygulama API anahtarlarını yönetmek için kullanılan özel bir anahtardır. Şu gibi API istekleri için gereklidir: Bir organizasyon API anahtarı oluşturmak için, OneSignal Panonuzda Organizations > your org > Keys & IDs’ye gidin.

Organizasyon API anahtarı, eski Kullanıcı Kimlik Doğrulama anahtarını değiştirir.

Uygulama API anahtarlarında olduğu gibi, 16’ya kadar org anahtarı yapılandırabilir ve IP izin listesi yapılandırmasını dahil edebilirsiniz.

​
API anahtarları oluşturma

  • Uygulama API Anahtarı – Uygulamanızın Settings > Keys & IDs’sine gidin veya API anahtarı oluştur API’sini kullanın.
  • Organizasyon API Anahtarı – Organizasyonunuzun Keys & IDs bölümüne gidin.
Oluşturma modalını açmak için Add Key’e tıklayın.

API anahtarları yalnızca bir kez görülebilir. Bir tane oluşturmak için Add Key kullanın.

Anahtarınıza açıklayıcı bir ad verin (ör. “CRM Senkronizasyon Hizmeti”).

​
IP izin listesi

İsteğe bağlı olarak, IP İzin Listesi’ni etkinleştirerek API anahtarı kullanımını belirli IP adreslerine kısıtlayın. Boşlukla ayrılmış CIDR blokları girin (ör. 192.0.2.0/24 192.0.2.123/32). İzin verilmeyen IP’lerden gelen istekler reddedilecektir.

İsteğe bağlı IP izin listesiyle bir API anahtarı oluşturma.

​
API anahtarlarını görüntüleme

Create’e tıkladıktan sonra, API anahtarınız bir kez gösterilecektir. Güvenli bir şekilde kaydedin.

Oluşturulan API anahtarı (yalnızca bir kez görüntülenir).

Continue’ya tıkladıktan sonra, anahtar artık görüntülenemeyecektir.

​
Anahtar yönetimi

Bir anahtar oluşturduktan sonra, anahtar listesi arayüzü aracılığıyla yönetebilirsiniz:

Key ID yalnızca referans için bir etikettir, gerçek API anahtarı değildir.

​
API anahtarlarını düzenleme

Pano veya API anahtarını güncelle API’si aracılığıyla:
  • Adı veya IP izin listesini güncelleyin
  • Sırrı değiştirmez—uygulama kodu değişikliği gerekmez

​
API anahtarlarını döndürme

Pano veya API anahtarını döndür API’si aracılığıyla:
  • Anahtarın sırrını değiştirir
  • Aynı adı ve IP ayarlarını koruyun
  • Uygulamanızı veya entegrasyonunuzu yeni anahtarla güncellemeniz gerekir

​
API anahtarlarını silme

Pano veya API anahtarını sil API’si aracılığıyla:
  • Anahtarı kalıcı olarak siler
  • Bu anahtarı kullanarak daha fazla API erişimini engeller

​
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 zengin API anahtarı oluşturun (yukarıya bakın).
  2. Kod tabanınızdaki eski anahtarı değiştirin.
  3. API çağrılarını eski https://onesignal.com/api/v1/ URL’si yerine https://api.onesignal.com kullanacak şekilde güncelleyin.
  4. Keys & IDs sayfasından eski anahtardaki “Disable Legacy Key“‘i silin veya tıklayın.

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

Bir uygulamayı devre dışı bırakmak şunları engeller:
  • Yeni bildirimler
  • Gönderilmeyi bekleyen planlanmış bildirimler
Yeni cihaz aboneliklerini engellemez. Bunları önlemek için, OneSignal kodunu uygulamanızdan kaldırmanız gerekir. Devre dışı bırakılan uygulamalar, panoda herhangi bir zamanda yeniden etkinleştirilebilir.