API neden gereklidir
API (Application Programming Interface) — farklı programlar arasındaki etkileşim için bir işlevselliktir. İnsanlar için ayrı arayüzler vardır, örneğin bir site. API çeşitli entegrasyonlar için gereklidir. Sender Solutions'ın, JSON formatında HTTP istekleri yardımıyla çalışan bir API'si vardır. API'ye erişim, ücretsiz tarife planı dahil olmak üzere projenin tüm tarife planları için sağlanır. Daha eksiksiz ve esnek bir entegrasyon için Sender Solutions API'sini kullanabilirsiniz. API'nin öngörülen kullanım formatı — sitenizden tetikleyicilere dayalı olarak. Örneğin, sitenizde bir abone oluşturulduğunda, site bir API isteği yürütür ve aynı verilere sahip bir abone Sender Solutions'ta oluşturulur.
API kullanımına başlangıç
- API'yi kullanmak için Sender Solutions Kişisel hesabında bir proje oluşturmanız gerekir.
- Ardından proje ayarları sayfasında bir API anahtarı oluşturun. Bu, bu proje düzeyinde API'ye benzersiz bir erişim anahtarıdır. Onu gizli tutun. Anahtarın ele geçirildiğine dair bir şüphe varsa, en kısa sürede yeni bir anahtar kullanmaya başlayın, ele geçirilen anahtarı ise devre dışı bırakın veya silin.
- Bir proje için birden fazla API anahtarı oluşturulabilir — hepsi eşdeğerdir. API istekleri yürütecek birden fazla farklı uygulamanız varsa bu faydalı olabilir.
- API anahtarı, Authorization HTTP başlığında iletilmelidir.
- İsteğin gövdesini JSON formatında iletin, Content-Type başlığında ise application/json değerini belirtin.
- Yanıtın HTTP durumuna göre hareket edin. Kod 200 ise — her şey başarılı oldu. Kod 500 ise — bir hata oluştu.
- API'den gelen yanıt genel olarak JSON formatında döndürülür. Kök düzeyinde, olası değerleri true / false olan "success" anahtarı bulunur.
Başarılı yanıt örneği:{
"success": true
}
Hatalı yanıt örneği:{
"error": "Some error description",
"success": false
}
Başarılı bir yanıtın gövdesinde, belirli isteğe bağlı olarak ek veriler olabilir. - API ile çalışmak için cookies veya oturum desteği gerekmez.
Faydalı kaynaklar
Composer php'de API ile çalışmak için paket: sender-solutions/php-sdk ve aynı paket github'da: Sender-Solutions/php-sdk
Postman API isteklerinin koleksiyonu şu adreste mevcuttur bağlantı