REST API
Kaynakları adreslerle tanımlayan ve okuma, ekleme, güncelleme gibi işlemleri standart HTTP yöntemleriyle yapan yaygın API tasarım biçimidir.
REST API, web üzerinden çalışan API'lerin en yaygın tasarım biçimidir. Her veri türü (müşteri, randevu, çağrı) bir adresle temsil edilir ve bu adres üzerinde ne yapılacağı standart HTTP yöntemleriyle söylenir.
Temel kurallar
| Yöntem | Ne yapar? | Örnek |
|---|---|---|
GET | Okur | GET /v1/santral/calls çağrı listesini getirir |
POST | Yeni kayıt ya da işlem oluşturur | POST /v1/santral/calls arama başlatır |
PUT / PATCH | Günceller | Bir kaydın bilgisini değiştirir |
DELETE | Siler | Bir kaydı kaldırır |
Cevabın sonucu HTTP durum koduyla bildirilir: 200 başarılı, 401 kimlik geçersiz, 404 kayıt yok, 422 gönderilen alanlarda hata, 429 çok fazla istek. Veri genellikle JSON biçimindedir.
Neden yaygın?
Her programlama dili HTTP isteği gönderebildiği için REST API'ye her yerden bağlanılabilir. Kurallar tahmin edilebilir olduğundan bir REST API'yi öğrenen geliştirici diğerlerine de hızla alışır. Her istek kendi içinde tamdır; sunucu önceki istekleri hatırlamak zorunda kalmaz.
KuleConnect'te
- KuleConnect API'sinin
/v1/ile başlayan uçları bu yapıdadır: JSON gönderir ve alır, hatalı alanlarda422ileerrorsnesnesi, sınır aşımında429döner. - Ters yönde, Firma Entegrasyonlarım bölümü kendi yazılımınızın REST API'sinden müşteri, randevu ve hizmetleri belirlediğiniz aralıkla çeker. Ekrandaki API sözleşmesi kartı, sisteminizin hangi uçları hangi biçimde sunması gerektiğini yazar.
İlgili rehber
KuleConnect uçları için KuleConnect API'sine genel bakış ve kimlik doğrulama, kendi sisteminizden veri çekmek için Firma Entegrasyonlarım yazısına bakın.
Sık sorulanlar
API iki yazılımın konuşma kurallarının genel adıdır. REST API bu kuralların adresler, HTTP yöntemleri ve durum kodlarıyla kurulduğu belirli ve yaygın bir tasarım biçimidir.
REST belirli bir biçim şart koşmaz, ama bugün çoğunlukla JSON kullanılır.