API Tools

Ringkasan

API Tools digunakan untuk membantu developer menguji, mengecek, dan memastikan integrasi API TENTA berjalan dengan benar.

Dengan tools pendukung, tim teknis dapat mencoba endpoint, mengecek token, melihat respon API, dan menemukan kesalahan sebelum integrasi digunakan secara penuh.

API Tools biasanya digunakan saat proses setup, testing, debugging, atau pengecekan integrasi.

Kapan Digunakan

API Tools digunakan ketika tim teknis ingin melakukan pengujian API secara manual sebelum integrasi dijalankan di sistem utama.

Gunakan API Tools untuk:

Menguji endpoint API.
Mengecek apakah token sudah valid.
Melihat respon dari API.
Mencoba format request.
Mengecek error dari sistem.
Memastikan data yang dikirim sudah sesuai.

Tools Pendukung API

Beberapa tools yang umum digunakan untuk testing API:

1. Postman

Postman digunakan untuk mencoba request API secara visual.

Dengan Postman, developer dapat mengatur method, URL endpoint, header, body request, dan melihat hasil respon dari API.

2. Insomnia

Insomnia memiliki fungsi yang mirip dengan Postman.

Tools ini dapat digunakan untuk menguji endpoint, menyimpan request, dan mengecek respon API dengan lebih rapi.

3. cURL

cURL digunakan untuk mengirim request API melalui terminal atau command line.

Tools ini cocok untuk developer yang ingin melakukan pengujian cepat tanpa membuka aplikasi tambahan.

4. Log Sistem

Log sistem digunakan untuk melihat aktivitas request dan respon yang terjadi saat integrasi berjalan.

Log membantu tim teknis mengetahui apakah request berhasil, gagal, atau mengalami error tertentu.

Cara Testing Endpoint

1. Siapkan API Token

Pastikan API token sudah tersedia dan masih aktif.

Token diperlukan agar request API dapat dikenali oleh sistem TENTA.

2. Pilih Endpoint yang Ingin Diuji

Tentukan endpoint yang akan dites.

Contoh kebutuhan endpoint:

Mengirim pesan.
Mengambil daftar percakapan.
Melihat detail percakapan.
Mengecek saldo kredit.

Pilih endpoint sesuai kebutuhan testing.

3. Tentukan Method Request

Gunakan method request yang sesuai dengan endpoint.

Contoh method yang umum digunakan:

GET untuk mengambil data.
POST untuk mengirim data.
PUT / PATCH untuk memperbarui data jika tersedia.
DELETE untuk menghapus data jika tersedia.

Pastikan method yang digunakan sesuai dengan dokumentasi endpoint.

4. Masukkan Header Authentication

Tambahkan token pada bagian header request.

Header authentication digunakan agar sistem mengetahui bahwa request berasal dari pihak yang memiliki izin akses.

5. Isi Body Request Jika Diperlukan

Jika endpoint membutuhkan data tambahan, masukkan body request sesuai format yang diminta.

Contoh data yang mungkin dibutuhkan:

Nomor tujuan.
Isi pesan.
ID percakapan.
Channel pengiriman.
Parameter pencarian.

Pastikan format data sudah benar sebelum request dikirim.

6. Kirim Request

Kirim request melalui tools yang digunakan.

Setelah request dikirim, perhatikan respon dari API.

7. Cek Respon API

Periksa apakah request berhasil atau gagal.

Hal yang perlu dicek:

Status code.
Pesan respon.
Data yang dikembalikan.
Error message jika request gagal.

Jika request gagal, gunakan pesan error sebagai petunjuk untuk memperbaiki request.

Contoh Request Sederhana

Contoh sederhana saat developer ingin menguji endpoint untuk mengambil daftar percakapan:

Method: GET
Endpoint: [URL endpoint daftar percakapan]
Header:
Authorization: Bearer [API_TOKEN]

Jika token valid dan endpoint benar, sistem akan mengembalikan data percakapan sesuai izin akses yang tersedia.

Contoh lain saat ingin mengirim pesan:

Method: POST
Endpoint: [URL endpoint kirim pesan]
Header:
Authorization: Bearer [API_TOKEN]

Body:
{
  "to": "nomor_customer",
  "message": "Halo, ini pesan uji coba dari sistem."
}

Gunakan endpoint, parameter, dan format body sesuai dokumentasi API yang berlaku.

Contoh Penggunaan

Tim developer ingin menguji apakah API token sudah bisa digunakan.

Developer membuka Postman, memasukkan endpoint daftar percakapan, menambahkan token pada header, lalu mengirim request.

Jika respon berhasil muncul, berarti token dan endpoint sudah dapat digunakan.

Jika respon gagal, developer mengecek kembali token, method request, URL endpoint, dan format data yang dikirim.

Catatan Penting

Gunakan API token yang aktif dan benar.
Jangan membagikan token di tempat publik.
Pastikan endpoint dan method request sudah sesuai.
Gunakan data testing sebelum menghubungkan ke sistem utama.
Simpan hasil pengujian jika diperlukan untuk dokumentasi integrasi.
Jangan melakukan request berulang terlalu cepat agar tidak terkena rate limit.

Kendala yang Sering Terjadi

Token Tidak Valid

Cek kembali API token yang digunakan dan pastikan token masih aktif.

Endpoint Salah

Pastikan URL endpoint sudah benar dan sesuai dokumentasi.

Method Tidak Sesuai

Gunakan method yang sesuai, misalnya GET untuk mengambil data dan POST untuk mengirim data.

Body Request Salah Format

Periksa kembali struktur data yang dikirim, termasuk nama field dan format nilainya.

Respon API Error

Baca pesan error yang muncul, lalu cek token, endpoint, parameter, dan izin akses.

Langkah Selanjutnya

Setelah memahami API Tools, lanjutkan ke halaman berikutnya: