API adalah singkatan dari Antarmuka Pemrograman Aplikasi. Perangkat lunak apa pun dengan fungsi tertentu disebut sebagai aplikasi saat membahas API. Anda dapat membandingkan antarmuka API dengan perjanjian layanan antara dua program yang menentukan permintaan dan tanggapan. Jika Anda baru mengenal API, kami sarankan Anda memeriksa kami Panduan Pemula untuk API ke Ikhtisar untuk REST API blog sebelum membaca yang ini.
API REST memungkinkan Anda untuk mengakses data CRM melalui protokol HTTP/HTTPS. Anda dapat melakukan tindakan seperti membuat, memperbarui, mengambil, atau menghapus operasi pada informasi catatan CRM apa pun. Ini juga akan memungkinkan Anda untuk menyimpan data konfigurasi khusus ekstensi dan khusus pengguna atau terhubung ke aplikasi eksternal menggunakan data khusus ekstensi yang disimpan. Semua data ini dapat diakses menggunakan otorisasi dasar, yaitu dengan nama pengguna dan kunci akses.
Membuat API REST
Berikut adalah lima langkah umum yang dapat Anda gunakan untuk membuat API apa pun:
- Rencanakan API: Panduan untuk mendesain API Anda disediakan oleh spesifikasi API seperti OpenAPI. Sebaiknya pertimbangkan berbagai kasus penggunaan sebelumnya dan pastikan API mematuhi standar pengembangan API saat ini.
- Membangun API: Perancang API membuat prototipe API baru dengan sedikit modifikasi pada API yang ada. Pengembang dapat menyesuaikan prototipe dengan persyaratan internal setelah menjalani pengujian.
- Uji API: Mirip dengan pengujian perangkat lunak, pengujian API diperlukan untuk mencegah kesalahan dan kekurangan. Uji kekuatan API terhadap serangan online menggunakan alat untuk pengujian API.
- Dokumentasikan API: Meskipun API cukup jelas, dokumentasi dapat membantu pengguna dengan lebih mudah. Dalam arsitektur berorientasi layanan, API yang terdokumentasi dengan baik dengan berbagai fungsi dan kasus penggunaan lebih sering digunakan. Tulis dokumen bantuan untuk memberikan arahan dan membantu orang lain membangun API mereka.
- Pasarkan API: Ada pasar online tempat pengembang dapat membeli dan menjual API kepada orang lain, seperti halnya barang eceran di eBay, Amazon, dan Flipkart. Anda bisa mendapatkan uang dari API Anda dengan mendaftarkannya.
Blog ini akan mengajari Anda cara membuat perintah REST API khusus menggunakan Desainer API Vtiger. Jadi mari kita mulai.
Apa itu Desainer API?
Perancang API adalah alat atau pengembang aplikasi yang dapat digunakan untuk membangun API layanan web kustom. Anda dapat menentukan endpoint layanan kustom dan parameter kueri. API ini dapat digunakan untuk berinteraksi dengan data CRM, berintegrasi dengan aplikasi eksternal dan juga memaparkan data ini ke API Javascript VTAP untuk digunakan dalam halaman atau widget khusus di Vtiger UI.
Anda dapat membuat API menggunakan Bahasa Desain Aplikasi Vtiger (VADL), yang secara longgar didasarkan pada sintaks XML. VADL memungkinkan administrator atau pengembang tanpa keterampilan pemrograman tingkat tinggi dengan mudah menentukan API, tetapi dengan pemahaman dasar tentang pemrograman, Anda dapat membuat API yang efektif dengan cepat.
REST API mengikuti protokol REST API standar, dan Anda dapat menentukan titik akhirnya sebagai berikut:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
Untuk REST API, metode permintaan HTTP berikut didukung:
- DAPATKAN
- POST
- PUT
- DELETE
Mari kita lihat bagaimana Anda dapat menggunakan VTAP untuk membangun REST API kustom Anda.
Pengguna Vtiger CRM dapat membuat API REST yang akan menghubungkan CRM ke aplikasi pihak ketiga lainnya atau membuat aplikasi baru yang akan memperluas fungsionalitas CRM. Ini contohnya:
Mari kita buat REST API yang bisa mengakses data dari spesifik modul menggunakan VTAP.
Berikut ini adalah contoh dari API yang mengambil data dari modul CRM yang dipanggil Organisasi untuk menampilkan lima organisasi teratas dengan pendapatan tahunan tertinggi dengan nama API sebagai organisasi_atas. Anda dapat menggunakan nama yang berbeda agar tetap unik.
Sebelum kita mulai, mari kita pahami komponen XML dan VDAL yang akan digunakan untuk menentukan tindakan dari contoh API di atas.
Tabel berikut menjelaskan komponen XML dan VDAL yang akan digunakan untuk menentukan API REST kustom untuk mengakses dan menampilkan data CRM:
| Komponen XML dan VDAL | Tindakan |
|---|---|
| metode api = "dapatkan" | Menentukan metode Permintaan HTTP |
| pilih modul = ”Akun” | Tentukan modul untuk mengambil data dari penggunaan memilih |
| catatan nama field=”nama akun”> | Tentukan bidang dalam rekaman untuk mengambil data dari penggunaan catatan |
| jenis nama bidang=”pendapatan_tahunan” pesanan=”turun” /bidang /menyortir |
Tentukan kondisi untuk hasil tabel menggunakan jenis |
| batas maks=”5″ halaman=”@halaman” /batas | Tentukan jumlah detail rekaman yang akan ditampilkan menggunakan membatasi |
| /Pilih / api |
Akhiri dengan menutup semua tag terbuka |
Note bahwa semua komponen XML dan VDAL dalam tabel di atas harus dilampirkan dengan tag(<>).
Ikuti langkah-langkah ini untuk membangun REST API yang dibahas di atas:
- Masuk ke akun Vtiger CRM Anda.
- klik Menu utama.
- Klik Platform.
- Pilih Desainer API API.
- Klik +Tambahkan API.
- Klik membuat di samping REST API. Tambahkan jendela REST API terbuka.
- Tambahkan REST API: Masukkan atau pilih informasi berikut ini:
- Modul: Pilih modul CRM dari mana data harus diakses.
- Nama: Masukkan pengidentifikasi unik untuk API.
- Status: Klik Kotak Centang untuk mengaktifkan API.
- Klik Simpan.
- Setelah Anda menambahkan API, Anda akan melihat IDE bawaan tempat Anda akan menggunakan VADL untuk menentukan API dan node XML untuk mengambil data CRM. Lihat tabel di atas untuk memahami komponen XML dan VADL.
- Klik Simpan dan Terbitkan untuk mempublikasikan API yang dibangun.
Anda dapat mengakses dan menguji REST API di atas dari aplikasi eksternal apa pun menggunakan URL berikut.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
Note bahwa URL di atas adalah contoh, dan Anda harus menentukan titik akhir sesuai contoh CRM Anda.
Tahukah Anda?
Data di atas dapat digunakan untuk ditampilkan sebagai daftar pada halaman khusus atau digunakan untuk bagan batang dan hasil dinamis lainnya menggunakan komponen javascript untuk menentukan API Anda. Semua API REST khusus yang dibangun di Desainer API juga dapat diakses menggunakan API Javascript VTAP.
Untuk mengetahui lebih lanjut tentang membuat API khusus dan VTAP, lihat Dokumentasi VTAP.
