Dokumentasi chevron_right Pengenalan

1. Pengenalan WhatsApp Bot API

WhatsApp Bot API Orbit adalah layanan antarmuka pemrograman aplikasi (API) RESTful yang memungkinkan developer untuk mengintegrasikan fungsionalitas WhatsApp ke dalam sistem mereka dengan cepat dan stabil. Konsepnya serupa dengan layanan WhatsApp API populer seperti Fonnte.

Kegunaan Utama API Kami:

chat

Kirim Pesan Otomatis

Kirim balasan chat atau broadcast otomatis kepada pelanggan.

notifications

Notifikasi Sistem

Berikan update status pesanan atau transaksi secara real-time.

lock

Verifikasi OTP

Kirim kode verifikasi rahasia yang aman via WhatsApp.

campaign

Pesan Promosi

Kelola kampanye marketing WhatsApp untuk meningkatkan konversi.

2. Cara Mendapatkan API Key

Ikuti langkah-langkah berikut untuk mendapatkan otorisasi akses API:

Masuk ke Dashboard Orbit

Menu API

Buka menu API Keys di sidebar

Generate

Klik tombol Generate New Key

Copy

Salin Token untuk digunakan

3. Base URL

Gunakan alamat URL dasar berikut untuk setiap pemanggilan endpoint API:

https://www.orbitwaapi.site/api/v1

4. Autentikasi API

Setiap request harus menyertakan API Key dalam Header Authorization dengan format **Bearer Token**.

Contoh Header HTTP

GET /v1/devices HTTP/1.1
Host: api.orbitapi.com
Authorization: Bearer YOUR_SECRET_API_KEY
Content-Type: application/json

5. Referensi Endpoint API

Autentikasi & Akun

POST /auth/register

Membuat akun baru untuk mendapatkan akses ke dashboard dan API.

{
  "name": "Budi Santoso",
  "email": "budi@example.com",
  "password": "rahasia123",
  "password_confirmation": "rahasia123"
}

{
  "message": "User successfully registered",
  "user": { "id": 1, "name": "Budi", "email": "budi@..." }
}

POST /auth/login

{
  "access_token": "eyJhbGciOiJIUz...",
  "token_type": "bearer",
  "expires_in": 3600
}

Pesan WhatsApp

POST /v1/messages/send

Mengirimkan pesan teks atau media (gambar) ke nomor WhatsApp.

Parameter (JSON Body)

Nama	Tipe	Wajib	Keterangan
to	string	Ya	Nomor tujuan (format internasional: 628...)
message	string	Ya	Isi pesan teks
file	string (URL)	Opsional	URL publik gambar untuk dikirim
device_id	int	Opsional	ID Device spesifik

{
  "to": "6285218574781",
  "message": "Halo dari Orbit API! 🚀",
  "file": "https://orbit.../logo.png"
}

{
  "message_status": "Success",
  "data": {
    "message_id": "MSG-30005-20260314",
    "status": "sent"
  }
}

GET /v1/messages

Melihat daftar riwayat pesan yang telah dikirim.

{
  "data": [
    { "id": 1, "external_id": "MSG-30001-20260314", "status": "read" }
  ],
  "total": 120
}

GET /v1/messages/{id}/status

Cek detail status pengiriman pesan tertentu.

{
  "message_id": "MSG-30005-20260314",
  "status": "delivered",
  "sent_at": "2026-03-14T17:37:26Z",
  "delivered_at": "2026-03-14T17:37:30Z"
}

Manajemen Device

GET /v1/devices

Melihat daftar perangkat WhatsApp Anda.

[
  { "id": 1, "name": "Device Utama", "status": "connected" }
]

GET /v1/devices/{id}

Melihat detail spesifik dari satu perangkat.

{
  "id": 1,
  "name": "Samsung S21",
  "phone_number": "62812345678",
  "status": "connected"
}

6. Contoh Request Menggunakan cURL

Gunakan perintah terminal berikut untuk pengujian cepat tanpa software tambahan:

curl -X POST https://www.orbitwaapi.site/api/v1/messages/send \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "to": "628123456789",
  "message": "Test cURL Orbit"
}'

7. Scalar API Documentation

Gunakan file spesifikasi API kami untuk mengimpor seluruh endpoint ke aplikasi API client favorit Anda (seperti NativeRest atau Postman) tanpa perlu mengetik manual.

Unduh Spesifikasi API

Klik tombol di bawah untuk mendapatkan file openapi.json.

Scroll ke Scalar API

Scroll ke bawah untuk melihat antarmuka Scalar yang sudah kami sediakan.

PENTING: Impor File JSON

Pastikan Anda mengklik tombol Import pada Scalar di bawah, lalu pilih file JSON yang baru saja diunduh agar seluruh endpoint muncul.

download Download JSON untuk Import

auto_awesome

Auto-Populate Ready

File ini sudah dilengkapi dengan contoh body JSON sehingga Anda tidak perlu mengetik lagi secara manual.

info

Dokumentasi Scalar memberikan antarmuka interaktif yang lebih lengkap untuk mencoba setiap endpoint API kami secara langsung.

8. Contoh Implementasi Sederhana

// Menggunakan Laravel Http Client
use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_API_KEY')
    ->post('https://www.orbitwaapi.site/api/v1/messages/send', [
        'to' => '6285218574781',
        'message' => 'Halo dari Orbit API! 🚀'
    ]);

return $response->json();

// Menggunakan Fetch API
const response = await fetch('https://www.orbitwaapi.site/api/v1/messages/send', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        to: "6285218574781",
        message: "Hello dari JavaScript!"
    })
});

const result = await response.json();
console.log(result);

# Menggunakan library 'requests'
import requests

url = "https://www.orbitwaapi.site/api/v1/messages/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "to": "6285218574781",
    "message": "Hello from Python!"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())