İçeriğe geçin

Arayüz sözleşmesi

Arayüz sözleşmesi, kararlaştırılmış veri alışverişini açıklar. Veri yapısı, yanıtlar ve bunların anlamı iki taraf için de birbiriyle uyumlu olmalıdır.

Diğer adlarıAPI sözleşmesi
API ve entegrasyon

Arayüz sözleşmesi, sistemlerin nasıl veri alışverişi yapacağına ilişkin üzerinde anlaşılmış tanımdır. Beklenen girdiler, yanıtlar, hatalar ve bu geri bildirimlerin anlamı kapsama girer. Makinece okunabilir bir tanım bunların bir kısmını ifade edebilir; iş kuralları üzerindeki anlaşmalar da anlaşılır olmalıdır.

Yanıtın anlamını kaydedin

Kurgusal müşteri portalında başarılı iletim, başlangıçta yalnızca bir aracı bileşenin veriyi aldığını doğrular. ERP’nin siparişi oluşturup oluşturmadığı ayrı bir geri bildirim gerektirir. Gönderen ilk yanıtı işin tamamen bittiği şeklinde yorumlarsa kullanımı anlaşmayla örtüşmez.

Tanımı uygulamayla karşılaştırın

OpenAPI, HTTP API’leri için standart bir tanım sunar. Bu tür tanımlar, kullanılabilir işlemleri ve yanıtları anlaşılır kılar. Ancak çalışan uygulamanın kararlaştırılmış akışı yerine getirdiğini tek başına kanıtlamaz. Uygun örnekleri ve hata durumlarını uygulamayla karşılaştırın. Değişikliklerde de hangi sistemin hangi anlaşmaya göre hareket ettiği açık olmalıdır.

Kaynaklar

Bu konudaki yazılar

ASES ile API ve entegrasyon

ERP, CRM ve mağaza sorunsuz bağlantılı