Ne döner?
Çağrının sonucunda hangi bilginin geldiği; alan listesi değil, anlamı
Rehber
ERP API entegrasyonuna başlamadan önce hangi bilgileri hazırlamalısınız?
Bu rehber, entegrasyon görüşmesinden önce ekiplerin aynı kavramlarda ve bağlantı sınırlarında buluşması için netleştirilmesi gerekenleri sıralar.
Adım 1
Önce kullanıcı işlemini yazın.
API’den başlamayın; kullanıcının ne yaptığından başlayın.
Teknik tanım kullanıcı işleminden çıkar, tersi değil. “İzin bakiyesi API’si” bir başlangıç noktası değildir; “çalışan kalan iznini öğrenmek istiyor” bir başlangıç noktasıdır. İkincisinden birincisi çıkar, ama birincisinden ikincisi çıkmaz.
İşlemi tek cümleyle yazın: kim, neyi, ne zaman istiyor. Bu cümle netleşmeden hangi ucun gerektiği de netleşmez.
Adım 2
API’nin işlevini sonuç üzerinden açıklayın.
Uç noktanın adı değil, döndürdüğü sonuç konuşulur.
Ne değişir?
İşlem yapan bir uçsa ERP’de neyin oluştuğu ya da hangi akışın başladığı
Hangi koşulla?
Çağrının çalışması için gereken parametreler ve ön koşullar
Ne dönmez?
Uç noktadan beklenmemesi gereken bilgiler — bağlantı sınırları tartışmasını baştan kapatır
Adım 3
Erişim ve kayıt ilişkisini belirleyin.
Kullanıcının ERP’deki karşılığı yoksa kayda bağlı erişim açılmaz; eşleşme tek başına yetki vermeye de yetmez.
- Kullanıcı kim?
Müşteri, çalışan ya da tedarikçi — üçü için ayrı erişim kapsamı tanımlanır.
- Hangi kayıtla eşleşiyor?
Özlük kaydı, müşteri kaydı ya da abone kaydı
- Eşleşme neyle kuruluyor?
Telefon numarası, e-posta adresi ya da başka bir alan
- Eşleşme yoksa ne olur?
Kayıtta karşılığı olmayan kullanıcının ne göreceği baştan tanımlanmalıdır.
Adım 4
API ile webhook ihtiyacını ayırın.
İkisi farklı sorulara yanıt verir ve her akışta ikisi birden gerekmez.
| Yöntem | Ne zaman gerekir? | Örnek |
|---|---|---|
| API çağrısı | Kullanıcı bir şey istediğinde bilgi okumak ya da işlem başlatmak için | Çalışan bakiyesini sorar |
| Webhook | ERP’de bir olay oluştuğunda kullanıcıya ulaşmak için | Kayıt onaya düştüğünde bildirim gider |
| İkisi birden | Kullanıcı bir talep açıyor ve sonucundan haberdar olacaksa | Talep açılır, karar verilince bildirim gider |
Adım 5
Kontrol için örnekler hazırlayın.
Doküman yeterli değildir; çalışan bir örnek her tartışmayı kısaltır.
Görüşmeye getirilecek örnekler:
- Not Örnek Sorgu Gerçek bir çağrı ve döndürdüğü sonuç
- Not Örnek İşlem Kayıt oluşturan bir çağrı ve ERP’deki karşılığı
- Not Hata Durumu Eksik parametre ya da yetkisiz çağrıda ne döndüğü
- Not Deneme Ortamı Üretim sistemini etkilemeden kontrol yapılabilecek bir kopya
Adım 6
Başlangıç bağlantısını tek tabloda toplayın.
Dağınık bilgi, görüşmede bağlantı kapsamının gereksiz yere büyümesine yol açar.
| Bilgi | Yazılacak Açıklama |
|---|---|
| Kullanıcı ve rol | İşlemi kim yapacak; hangi kayıtlarla ilişkili? |
| İşlem | Bilgi sorgulama, kayıt oluşturma ya da iş akışı başlatma mı? |
| API / olay | İlgili API uç noktası ya da webhook olayı nedir? |
| Alınan ve sunulan bilgi | Kullanıcıdan hangi alanlar istenir; sonuç nasıl yorumlanır? |
| Erişim | Kimlik, rol ve kayıt sınırı nasıl uygulanır? |
| Kontrol | Hangi örneklerle başarı ve hata durumları incelenecek? |
| Sorumlu | Süreç, ERP/API ve ürün tarafında kim çalışacak? |
Bilgi
Tek satırlık bağlantı cümlesi.
Şu kalıbı doldurabiliyorsanız hazırsınız: “[kullanıcı], [kanal] üzerinden [bilgi]’yi görebilecek ve [işlem]’i başlatabilecek; bunun ERP karşılığı [API uç noktası] ve sonucu [kayıt].” Doldurulamayan her boşluk, görüşmede konuşulacak bir başlıktır.
Adım 7
Takvimi hazırlıkla birlikte değerlendirin.
Ürün tarafındaki yapılandırma ile API hazırlığı aynı takvimde ilerlemez.
Devreye alma takvimi iki ayrı işten oluşur: ürün tarafındaki yapılandırma ve sizin tarafınızdaki API hazırlığı. İkincisi genellikle belirleyici olandır ve bu yüzden takvim, API’nin ne zaman hazır olacağına bağlıdır.
Bu iki işi ayrı planlayın; birini diğerinin içinde saymak, gecikmenin nereden geldiğini görünmez kılar.
İlgili Sayfalar
Hazırladığınız bağlantı tanımı nerede kullanılır?
ERP ailenize göre bağlantı yaklaşımı, dört adımlık devreye alma ve API erişiminin kuralları.
Sonraki Adım
İlk ERP işleminizin bağlantı kapsamını birlikte değerlendirelim.
Kullanıcı işlemini ve elinizdeki API bilgisini paylaşın. Bağlantı kapsamını görüşmede çıkaralım.