API Documentation

Diperbarui 22 Jun 2026

Dokumentasi ringkas dan profesional untuk menghubungkan aplikasi Anda ke NEXOTP API: membuat API key, membaca katalog, membuat order, mengecek status OTP, dan membatalkan order aktif.

A. Persiapan

Sebelum integrasi, buat akun dan generate API key dari dashboard. API key hanya tampil sekali saat dibuat, jadi simpan di environment backend Anda.

A.1. Base URL

Example

https://webnokosai.vercel.app

B. Authentication

Semua endpoint API v1 membutuhkan header Authorization dengan format Bearer token.

Example

Authorization: Bearer nx_live_xxxxxxxxxxxxxxxxx

C. Daftar Endpoint

GET

/api/v1/balance

Mengambil saldo wallet akun yang sedang digunakan. Gunakan endpoint ini sebelum membuat order untuk memastikan saldo cukup.

GET

/api/v1/services

Mengambil daftar layanan OTP yang tersedia untuk order. Data ini dipakai untuk menampilkan pilihan aplikasi atau platform kepada user.

GET

/api/v1/countries

Mengambil daftar negara yang dapat digunakan untuk order nomor virtual. Gunakan countryCode pada request order.

GET

/api/v1/providers

Mengambil daftar provider yang tersedia untuk kombinasi layanan dan negara. Gunakan providerCode untuk memilih provider spesifik.

POST

/api/v1/order

Membuat order nomor virtual baru. Sistem akan memvalidasi saldo, menghitung harga final, membuat order, dan mengembalikan nomor jika tersedia.

GET

/api/v1/order/{id}

Mengambil detail order, status terbaru, nomor virtual, countdown, dan kode OTP jika sudah diterima.

POST

/api/v1/order/{id}/cancel

Membatalkan order aktif. Jika order memenuhi syarat refund, saldo akan dikembalikan melalui wallet transaction.

D. Contoh Integrasi

Contoh berikut membaca daftar layanan aktif.

Example

curl -X GET "https://webnokosai.vercel.app/api/v1/services" \
  -H "Authorization: Bearer nx_live_xxx"

E. Error Handling

Gunakan status HTTP dan field error untuk menentukan retry. Jangan retry order tanpa idempotency key karena dapat membuat order ganda.

Example

{
  "success": false,
  "error": "Insufficient balance",
  "requestId": "req_01HX..."
}