Terhubung ke API Tanpa Kode: 8 Langkah

2024 Pengarang: John Day | [email protected]. Terakhir diubah: 2024-01-30 09:54

Panduan ini dirancang untuk orang-orang yang memiliki sesuatu yang ingin mereka capai yang memerlukan penggunaan API, tetapi tidak yakin bagaimana memulainya. Anda sudah tahu mengapa bisa bekerja dengan API itu berguna, dan panduan ini akan menunjukkan cara melakukannya.

Jika itu terdengar seperti Anda, Anda beruntung! Kami di sini untuk menjelaskan cara bekerja dengan API, cara membaca dokumen API, dan cara benar-benar menggunakan data yang kembali dari API.

Kami telah membawa seorang teman untuk membuat perjalanan lebih mudah.

Temui Slash

Slash adalah anjing Michelle yang menggemaskan (digambarkan di atas). Michelle adalah seorang insinyur perangkat lunak yang membuat API. Michelle sangat menikmati pekerjaannya dan telah mengambil inspirasi dari pekerjaannya membangun API dalam pelatihan Slash.

Seperti yang Anda ketahui, API adalah kumpulan perintah yang dapat diberikan pengguna ke layanan web bersama dengan serangkaian respons yang sesuai dengan permintaan. Michelle telah melatih Slash untuk melakukan hal yang sama. Slash adalah anak yang baik, tahu berbagai perintah, dan selalu merespon dengan benar selama Anda memberinya permintaan yang telah diajarkan kepadanya. Ketika dia menjadi sangat bersemangat, ekornya menjadi gila - ini bukan sesuatu yang diajarkan Michelle kepadanya terkait dengan API, itu hanya karena dia adalah anak anjing yang menyenangkan dan sangat menikmati pelatihannya!

Langkah 1: Tentukan API Apa yang Anda Butuhkan

Informasi apa yang Anda cari atau ingin Anda ubah?

Apakah Anda mencoba mengambil semua postingan Instagram @dougthepug? Mungkin Anda ingin men-tweet secara otomatis kepada siapa saja yang mengikuti twitter anjing Anda (karena meskipun anjing tidak dapat berbicara, mereka memiliki banyak hal untuk dikatakan, kami tahu Slash pasti melakukannya).

Jika Anda sudah mengetahui situs atau API yang Anda coba sambungkan, langsung ke Langkah 2. Jika Anda mencoba mencari data, tetapi tidak yakin harus mulai dari mana, Google adalah teman Anda. Cari "[hal yang Anda minati] API" dan lihat apa yang muncul. Anda mungkin terkejut betapa banyak informasi di luar sana.

Jika Anda menginginkan contoh API sederhana, Anda dapat menggunakan yang dibuat Michelle saat melatih Slash. Ia memiliki beberapa perintah favoritnya seperti mengambil bola dan menggali lubang. Kami akan menggunakannya sepanjang sisa contoh kami.

Langkah 2: Temukan Dokumen API

API yang disediakan oleh perusahaan terkenal harus memiliki dokumentasi menyeluruh tentang cara menggunakannya.

Untuk menemukannya, google "[Insert Company] API dokumentasi" atau "[Insert Company] developer".

Hasilnya akan membawa Anda ke portal pengembang. Cari tautan yang bertuliskan "Dokumen", "Dokumentasi", "Referensi" atau "Referensi Teknis".

Di dalam dokumen, Anda mungkin perlu mencari API spesifik yang Anda inginkan karena terkadang ada banyak opsi. Facebook, misalnya, memiliki API terpisah untuk pemasaran, iklan, halaman, dan lainnya.

Jika API yang ingin Anda sambungkan tidak dikenal (seperti Slash), Anda mungkin perlu meminta dokumentasi dari pengembang. Mereka mungkin memiliki PDF yang berisi informasi yang Anda butuhkan atau dokumentasi online yang tidak terdaftar di situs web mereka.

Jika Anda melewatkan tautan di langkah sebelumnya, dokumen API Slash dapat ditemukan di sini.

Langkah 3: Temukan Titik Akhir

Dokumen API mungkin terlihat menakutkan, tetapi begitu Anda tahu apa yang harus dicari, dokumen tersebut biasanya terstruktur dengan baik dan cukup terstandarisasi.

Hal pertama yang harus dicari adalah titik akhir yang sesuai. Harus ada satu titik akhir yang sesuai dengan setiap jenis data yang Anda inginkan. Titik akhir dapat terlihat seperti ini:

slashtheapidog.com/api/bones/{id}

atau hanya

/tulang

Dokumentasi harus memiliki daftar titik akhir. Mereka mungkin tingkat atas dalam dokumen atau di bawah bagian yang disebut "referensi", "titik akhir", atau "metode". Untuk menemukan titik akhir yang tepat, cari nama yang sesuai dengan data yang Anda cari. Misalnya, jika Anda ingin daftar semua lubang yang telah digali Slash, /holes mungkin yang benar. Bagaimanapun, setiap titik akhir harus memiliki deskripsi untuk membantu menjelaskan fungsinya.

Dari dokumennya, ini adalah titik akhir di API Slash yang terkait dengan lubang:

DAPATKAN

DAPATKAN

POSTING

PUT

POSTING

Langkah 4: Tentukan Jenis Permintaan Anda

Sekarang setelah Anda menemukan titik akhir yang tepat, Anda perlu menentukan jenis permintaan untuk mengirimkannya.

Ada 4 jenis permintaan yang berbeda:

DAPATKAN

Permintaan GET adalah cara Anda meminta API untuk merespons dengan sesuatu yang dimilikinya, paling sering berupa data. Anda dapat meminta informasi spesifik tentang satu item atau sekelompok item berdasarkan titik akhir dan parameter. Ini sama dengan meminta Slash untuk membawakan salah satu tulangnya atau semua tulangnya.

POS

Permintaan POST adalah cara Anda memberi tahu API untuk membuat sesuatu yang baru. Ini mirip dengan meminta Slash untuk menggali (membuat) lubang baru untuk Anda.

TARUH

Permintaan PUT adalah cara Anda memberi tahu API untuk memperbarui sesuatu yang telah dibuat sebelumnya. Ini mirip dengan meminta Slash untuk menggali lebih dalam (update) ke dalam lubang yang dia gali.

MENGHAPUS

Permintaan DELETE adalah cara Anda memberi tahu API untuk menghapus sesuatu yang telah dibuat sebelumnya. Ini mirip dengan meminta Slash untuk menutupi (menghapus) lubang yang sebelumnya dia gali.

Pikirkan tentang empat jenis ini. Apakah Anda mendapatkan informasi, membuat entri baru, mengubah entri yang ada, atau menghapusnya? Jawaban itu memberi tahu Anda dengan tepat jenis permintaan apa yang Anda butuhkan.

Langkah 5: Pahami Parameter

Banyak permintaan memerlukan parameter tambahan. Parameter adalah detail permintaan Anda. Misalnya, jika Anda ingin Slash memberi Anda semua bola yang berwarna merah, Anda perlu menentukan warnanya. Jika Anda ingin dia membuat lubang baru, Anda harus memberi tahu dia di mana harus meletakkannya dan seberapa dalam untuk menggali.

Dokumentasi API yang Anda rujuk harus memiliki bagian yang disebut "Parameter" atau "Opsi" untuk setiap titik akhir dan jenis permintaan. Perhatikan parameter mana yang diperlukan karena beberapa bersifat opsional. Jika parameter ditandai sebagai opsional, dokumen mungkin memberikan contoh yang juga merupakan default.

Parameter API Slash mungkin terlihat seperti ini untuk mengambil bola:

DAPATKAN

Langkah 6: Format Permintaan Anda

Kami memiliki semua informasi yang kami butuhkan, sekarang kami hanya perlu membuat permintaan!

Berikut adalah dua cara berbeda untuk terhubung ke API yang tidak memerlukan kode. Mari terhubung ke API Slash untuk mendapatkan daftar bolanya dengan membuat permintaan GET ke

Parabola - jika Anda ingin terhubung dan bekerja dengan data tanpa kode

Parabola adalah aplikasi web yang memungkinkan Anda terhubung dengan mudah ke API dan kemudian bekerja dengan data melalui alat visual, drag-and-drop.