Tanım
REST API, mesajlar, kişiler veya şablonlar gibi kaynakları URL'ler üzerinden sunan ve programların bunları standart HTTP yöntemleriyle (POST, GET, PATCH, DELETE) oluşturmasına, okumasına, güncellemesine ve silmesine olanak tanıyan bir web arayüzüdür; genellikle JSON alışverişi yapılır.
REST (representational state transfer), Roy Fielding'in 2000'de tanımladığı bir mimari tarzdır. Pratikte bir mesajlaşma REST API'si, kimliği doğrulanmış bir HTTPS isteği göndermek (örneğin JSON gövdeli POST /messages) ve ID ile durum içeren bir JSON yanıt almak demektir. HTTP durum kodları sonucu bildirir: 2xx başarı, geçersiz numara veya eksik yetki gibi istemci hataları için 4xx, sunucu hataları için 5xx.
Tipik kalıplar: Authorization başlığında bearer token kimlik doğrulaması, yeniden denemelerin mükerrer gönderim yapmaması için idempotency anahtarları, listeler için sayfalama, retry-after başlıklı hız sınırları ve iletim raporları gibi asenkron sonuçlar için webhook'lar.
REST, CRM'ler, e-ticaret platformları ve arka ofis sistemleri gibi çoğu entegrasyona uygundur. Çok yüksek hacimli SMS'te operatörler ve aggregator'lar çoğunlukla kalıcı bağlantı açık tutan SMPP'yi kullanır.
Bir OpenAPI belirtimi uç noktaları makine tarafından okunabilir biçimde tanımlar; böylece istemci SDK'ları, dokümantasyon ve testler bundan üretilebilir.
OmniChannels.ai, https://api.broadnet.me adresinde bearer token kimlik doğrulamalı bir REST/JSON API, bir OpenAPI 3.1 belirtimi ve bir TypeScript SDK sunar.
Örnek
POST https://api.broadnet.me/… isteği, "Authorization: Bearer <token>" başlığı ve JSON gövdesiyle gönderilir; yanıt bir mesaj ID'si döndürür.