Definisi
REST API adalah antarmuka web yang menyediakan resource, seperti pesan, kontak, atau template, pada URL tertentu. Program dapat membuat, membaca, memperbarui, dan menghapus resource tersebut dengan metode HTTP standar (POST, GET, PATCH, DELETE), umumnya dengan pertukaran data dalam format JSON.
REST (representational state transfer) adalah gaya arsitektur yang dijelaskan oleh Roy Fielding pada tahun 2000. Dalam praktiknya, REST API untuk pesan berarti mengirim permintaan HTTPS terautentikasi, misalnya POST /messages dengan body JSON, lalu menerima respons JSON berisi ID dan status. Kode status HTTP menunjukkan hasilnya: 2xx berarti berhasil, 4xx adalah error dari sisi klien seperti nomor tidak valid atau otorisasi yang tidak ada, dan 5xx adalah error server.
Pola yang umum digunakan: autentikasi bearer token pada header Authorization, idempotency key agar percobaan ulang tidak mengirim pesan ganda, paginasi untuk daftar data, rate limit dengan header retry-after, dan webhook untuk hasil asinkron seperti laporan pengiriman (DLR).
REST cocok untuk sebagian besar integrasi: CRM, platform e-commerce, dan sistem back-office. Untuk SMS dengan volume sangat tinggi, operator seluler dan agregator sering memakai SMPP, yang menjaga koneksi tetap terbuka.
Spesifikasi OpenAPI mendeskripsikan endpoint dalam format yang dapat dibaca mesin, sehingga SDK klien, dokumentasi, dan pengujian dapat dibuat secara otomatis darinya.
OmniChannels.ai menyediakan REST/JSON API di https://api.broadnet.me dengan autentikasi bearer token, spesifikasi OpenAPI 3.1, dan SDK TypeScript.
Contoh
POST https://api.broadnet.me/… dengan header "Authorization: Bearer <token>" dan body JSON; respons mengembalikan ID pesan.