Proyek API opsional
Tampilkan operasi aplikasi yang telah disepakati saat Anda membutuhkannya
Tinjau cakupan API untuk proyek yang memenuhi syarat dan bedakan jalur yang direncanakan dengan endpoint yang sudah dibuat.
Anggap API sebagai opsi proyek yang telah ditentukan.
- Tinjau opsinya
Periksa ketersediaan API dan penawaran proyek terkait.
- Tentukan cakupan rute
Perjelas operasi bisnis yang harus diungkapkan oleh API.
- Periksa katalog rute
Lihat metode, jalur, dan status yang direncanakan atau aktif dari setiap rute.
Tambahkan API saat proyek Anda membutuhkannya
API proyek adalah bagian opsional dari penawaran. Tinjau cakupan dan persyaratannya sebelum mengaktifkan, alih-alih berasumsi bahwa setiap aplikasi menyertakannya.
Alat API mengatur rute yang diusulkan berdasarkan area bisnis. Klarifikasi membantu menentukan apa yang harus dilakukan setiap operasi sebelum implementasinya.
Bedakan rute yang diinginkan dari titik akhir yang berfungsi.
Siapkan akses untuk sistem lain. Sebuah proyek mungkin memerlukan aplikasi lain untuk menjalankan operasi bisnisnya. Tinjau cakupan dan penawaran API opsional, jangan berasumsi bahwa setiap fungsi secara otomatis tersedia. Operasi yang disepakati menentukan apa yang harus diakses oleh integrasi.
Periksa katalog rute. Katalog menampilkan metode, jalur, deskripsi, dan status setiap rute. Katalog ini membantu membedakan cakupan yang diusulkan dari titik akhir yang terdaftar sebagai aktif. Ini adalah referensi praktis saat mengikuti persiapan API.
Pilih arah integrasi yang benar. Menggunakan API penyedia lain dan mempublikasikan aplikasi Anda sendiri adalah kebutuhan yang berbeda. Koneksi eksternal mencakup yang pertama; API proyek mencakup eksposur yang disepakati. Pilih jalur yang sesuai dengan pertukaran bisnis yang Anda inginkan.
Bedakan API yang terbuka dari koneksi eksternal
API proyek menampilkan operasi yang telah disepakati dari aplikasi Anda. Koneksi eksternal menjelaskan bagaimana aplikasi Anda menggunakan layanan lain; keduanya melayani kebutuhan yang berbeda.
Gunakan katalog rute untuk memeriksa metode, jalur, dan apakah suatu endpoint direncanakan atau aktif. Presentasi ini tidak mengaktifkan API untuk proyek Anda.
Nilai opsi API berdasarkan kebutuhan nyata
Tentukan siapa yang akan menggunakan data proyek dan operasi apa yang dibutuhkan integrasi tersebut. Ini membantu membedakan cakupan API opsional dari koneksi ke layanan eksternal yang sudah ada.
Untuk proyek yang memenuhi syarat, periksa rute yang direncanakan dan status pembangunannya. Pastikan layanan dan lingkungan yang relevan sebelum menganggap sebuah endpoint tersedia untuk integrasi.
Dari cakupan opsional ke eksposur terverifikasi
Periksa ketersediaan dan ketentuan. Periksa opsi API di penawaran proyek. Tentukan apakah aplikasi memerlukan fitur ini sebelum diaktifkan.
Jelaskan operasinya. Tinjau operasi bisnis yang diusulkan dan jawab pertanyaan tentang perilaku yang diharapkan. Ikuti tahapan persiapan dan konstruksi.
Lihat apa yang sedang berlangsung. Periksa katalog rute dan referensi yang dipublikasikan untuk proyek yang aktif. Rute yang direncanakan bukanlah titik akhir yang berfungsi.
Tentukan cakupan integrasi sebelum menambahkan API
Jelaskan operasi yang dibutuhkan oleh sistem lain dan tinjau kondisi opsi tersebut. API harus menyediakan pertukaran bisnis yang telah disepakati.
Pertanyaan tentang API Proyek Opsional
Ini adalah opsi yang ketersediaan dan harganya tercantum dalam penawaran yang sebenarnya. Sebuah aplikasi dapat beroperasi tanpa mengaktifkannya. Presentasi ini tidak menyediakan atau mengaktifkan API untuk proyek Anda.
Ini menjelaskan operasi yang dimaksudkan yang belum terdaftar sebagai endpoint aktif. Gunakan status katalog dan referensi yang dipublikasikan sebenarnya sebelum memulai integrasi.
Tampilan API proyek menunjukkan area yang akan ditampilkan, pertanyaan, infrastruktur, dan status konstruksi. Selesaikan prasyarat yang disebutkan dan periksa katalog rute yang dihasilkan.
Gunakan referensi API yang terkait dengan proyek dan lingkungan yang aktif. Jangan mengambil contoh titik akhir atau autentikasi hanya dari rute yang direncanakan.
Mereka menjelaskan layanan lain yang digunakan aplikasi Anda. Arah integrasi itu berbeda dari penyediaan operasi aplikasi Anda sendiri melalui API proyek.