İsteğe bağlı proje API'si
İhtiyacınız olduğunda önceden tanımlanmış uygulama işlemlerini gösterin
Uygun bir proje için bir API kapsamını gözden geçirin ve planlanan yolları halihazırda oluşturulmuş uç noktalardan ayırt edin.
API'yi tanımlı bir proje seçeneği olarak ele alın
- Seçeneği inceleyin
API'nin kullanılabilirliğini ve ilgili proje teklifini kontrol edin.
- Rota kapsamını tanımlayın
API'nin hangi iş operasyonlarını sunacağını açıklayın.
- Rota kataloğunu inceleyin
Her güzergahın yöntemini, yolunu ve planlanan veya güncel durumunu görüntüleyin.
Projeniz gerektiğinde bir API ekleyin
Proje API'si teklifin isteğe bağlı bir parçasıdır. Etkinleştirmeden önce kapsamını ve koşullarını inceleyin, her uygulamanın bunu içerdiğini varsaymayın.
API araçları, önerilen güzergahları iş alanına göre düzenler. Açıklamalar, her bir işlemin uygulanmasından önce ne yapması gerektiğini tanımlamaya yardımcı olur.
Hedeflenen rotaları çalışan uç noktalarından ayırt edin
Başka bir sistem için erişim ayarlayın. Bir projenin iş operasyonları için başka bir uygulamaya ihtiyacı olabilir. İsteğe bağlı API kapsamını ve teklifini inceleyin, her fonksiyonun otomatik olarak kullanıma sunulduğunu varsaymayın. Anlaşılan operasyonlar, entegrasyonun hangi verilere erişmesi gerektiğini tanımlar.
Rota kataloğunu inceleyin. Katalog, her güzergahın yöntemini, yolunu, açıklamasını ve durumunu gösterir. Önerilen kapsamı, canlı olarak kaydedilmiş uç noktaların kapsamından ayırt etmeye yardımcı olur. API'nin hazırlanması sırasında takip edilen süreçte pratik bir referanstır.
Doğru entegrasyon yönünü seçin. Başka bir sağlayıcının API'sini kullanmak ve kendi uygulamanızı kullanıma sunmak farklı ihtiyaçlardır. Dış bağlantılar ilki için geçerlidir; proje API'si ise üzerinde anlaşılan kullanıma sunmayı kapsar. İhtiyaç duyduğunuz iş birliği türüne uygun olanı seçin.
Açıkta kalan bir API ile harici bir bağlantı arasındaki farkı açıklayın.
Bir proje API'si, uygulamanızın üzerinde anlaşmaya varılan işlemlerini kullanıma sunar. Harici bir bağlantı, uygulamanızın başka bir hizmeti nasıl kullandığını tanımlar; farklı ihtiyaçlara hizmet ederler.
Rota kataloğunu kullanarak yöntem, yol ve bir uç noktanın planlanmış mı yoksa aktif mi olduğunu inceleyin. Bu sunum, projeniz için bir API'yi etkinleştirmez.
API seçeneğini somut bir ihtiyaca göre değerlendirin
Projenin verilerini kimin kullanacağını ve bu entegrasyonun hangi işlemleri gerektirdiğini belirleyin. Bu, isteğe bağlı bir API kapsamını mevcut bir dış hizmetle bağlantıdan ayırt etmeye yardımcı olur.
Uygun bir proje için planlanan rotaları ve oluşturma durumlarını inceleyin. Bir uç noktayı entegrasyon için kullanılabilir saymadan önce ilgili hizmeti ve ortamı doğrulayın.
İsteğe bağlı bir kapsamdan doğrulanmış görünürlüğe
Mevcut durumu ve şartları gözden geçirin. Gerçek projede sunulan teklifte API seçeneğini kontrol edin. Uygulamanın bu özelliğe ihtiyacı olup olmadığını etkinleştirmeden önce belirleyin.
İşlemleri açıklayın. Önerilen iş operasyonlarını inceleyin ve beklenen davranışları hakkında soruları yanıtlayın. Hazırlık ve inşa aşamalarını takip edin.
Şu anda neler yayınlandı öğrenin. Etkinleştirilmiş bir proje için rota kataloğunu ve yayınlanmış referansı inceleyin. Planlanan bir rota, çalışan bir uç nokta değildir.
API eklemeden önce entegrasyon kapsamını tanımlayın
Diğer sistemin hangi işlemleri yapması gerektiğini açıklayın ve seçeneğin koşullarını gözden geçirin. API, üzerinde anlaşmaya varılmış bir iş sürecini desteklemelidir.
İsteğe Bağlı Proje API'si ile ilgili sorular
Bu, gerçek teklifte kullanılabilirliği ve fiyatı görünen bir seçenektir. Bir uygulama, bunu etkinleştirmeden çalışabilir. Bu sunum, projeniz için bir API sağlamaz veya etkinleştirmez.
Bu, henüz canlı bir uç nokta olarak kaydedilmemiş, planlanan bir işlemi açıklar. Entegrasyona başlamadan önce katalog durumunu ve yayınlanan gerçek başvuruyu kullanın.
Proje API görünümleri, açığa çıkarılacak alanları, soruları, altyapıyı ve inşaat durumlarını gösterir. Belirtilen ön koşulları çözün ve elde edilen rota kataloğunu inceleyin.
Etkin projenin ve ilgili ortamın API referansını kullanın. Yalnızca planlanan bir güzergadan bir uç nokta veya kimlik doğrulama örneği çıkarmayın.
Uygulamanızın kullandığı başka bir hizmeti açıklarlar. Bu entegrasyon yönü, uygulamanızın kendi işlemlerini proje API'si aracılığıyla kullanıma sunmaktan farklıdır.