API nedir, nasıl çalışır? İstekten yanıta basit anlatım
Bir uygulamanın başka bir sistemden bilgi alması gerektiğinde iki tarafın nasıl konuşacağını belirleyen kurallara ihtiyaç vardır. API bu etkileşim için bir arayüz sunar. Kullanıcının gördüğü ekran ile yazılımın kullandığı arayüz aynı şey değildir.
API açılımı ve anlamı nedir?
API, Application Programming Interface ifadesinin kısaltmasıdır; uygulama programlama arayüzü olarak çevrilebilir. Bir yazılımın başka bir yazılıma sunduğu işlemleri ve bunların nasıl kullanılacağını tanımlar. Bir kütüphanedeki fonksiyonlar veya tarayıcının sunduğu özellikler de API olabilir.
Web API örneğinde uygulama, belirli bir adrese istek gönderir ve tanımlı biçimde yanıt alır. Kullanıcı düğmeye basarken arka planda bu iletişim gerçekleşebilir. Her düğme mutlaka başka bir sunucuya bağlanmaz; bazı işlemler cihazın içinde yapılır.
İstek ve yanıt nasıl görünür?
Temsili bir kütüphane uygulamasında 42 numaralı kitabın bilgisini istediğinizi düşünün. Aşağıdaki adres çalışan bir hizmet değildir; akışı açıklamak için verilmiştir.
İstek:
GET /api/kitaplar/42
Örnek yanıt:
{
"id": 42,
"ad": "Örnek kitap",
"durum": "rafta"
}Uygulama bu veriyi alıp ekranda gösterebilir. Yanıttaki JSON bir veri biçimidir; bütün API’lerin JSON kullanması zorunlu değildir. API belgesi hangi alanların geleceğini, hangi işlemlerin desteklendiğini ve hata durumlarını açıklar.
Endpoint, yöntem ve API anahtarı ne demek?
Endpoint, belirli işlemin erişildiği adrestir. Örnekte kitap kaydının yolu bu görevi görür. HTTP yöntemi işlemin türünü belirtir; GET genellikle veri okumak, POST ise kaynağa veri göndermek için kullanılır. Gerçek davranışı ilgili API’nin belgesinden öğrenmelisiniz.
API anahtarı, bazı servislerin istemciyi veya projeyi tanımak ve erişimi yönetmek için kullandığı bilgidir. Bütün API’ler aynı kimlik doğrulama yöntemini kullanmaz. Gizli tutulması gereken anahtarı herkese açık kaynak koduna veya tarayıcıya gönderilen dosyalara koymayın; hizmetin önerdiği erişim yöntemini uygulayın.
Bir API çağrısı neden başarısız olabilir?
Adres yanlış olabilir, kayıt bulunmayabilir, yetki yetersiz olabilir veya servis geçici olarak yanıt vermeyebilir. Kullanım sınırı da aşılmış olabilir. Uygulama yalnızca başarılı yanıtı değil bu durumları da ele almalıdır.
Örneğin kitap bulunamadığında ekranda sonsuza kadar yükleniyor göstermek yerine anlaşılır mesaj sunulabilir. Kayıt oluşturan bir isteği düşünmeden tekrar göndermek ise aynı işi iki kez yapabilir. Yeniden denemenin güvenli olup olmadığı işlemin ve API’nin kurallarına bağlıdır.
API kullanmak ile entegrasyon kurmak aynı mı?
Tek başarılı istek, tamamlanmış entegrasyon değildir. İki sistemin alanlarını eşleştirmek, hataları izlemek, yetkileri ayarlamak ve değişen veriyi tutarlı taşımak gerekir. Bir sistemde “tamamlandı” sayılan iş, diğerinde hâlâ onay bekliyor olabilir.
Başlangıçta resmî belgeyi okuyun ve varsa deneme ortamında veri okuyan basit bir işlemle ilerleyin. Üretim verisini değiştirmeden önce hata ve tekrar senaryolarını sınayın. Konuyu iş akışına taşımak için API entegrasyonu planlama rehberindeki soruları inceleyebilirsiniz.
Kaynaklar ve ileri okuma
Bu rehber Ornitoreng tarafından yapay zekâ desteğiyle hazırlanmıştır. Örnekler temsili iş akışlarıdır; müşteri sonucu veya ürün performansı iddiası değildir.
Ornitoreng