Tài liệu tích hợp API
Hướng dẫn chi tiết cách sử dụng API để tích hợp dịch vụ SMS vào hệ thống của bạn.
Base URL
https://api.otpnhanh.net
Xác thực (Authentication)
X-API-KEY: your_api_key_string
GET
/account/api/v1/user/me
Lấy thông tin tài khoản & Số dư
Response Mẫu
{
"status": 200,
"success": true,
"data": {
"id": 1,
"email": "[email protected]",
"full_name": "Demo User",
"balance": 50000,
"deposit_memo": "NAP TIEN ABC",
"api_key": "YOUR_API_KEY_HERE"
}
}GET
/sms/api/v1/products-meta
Lấy danh sách dịch vụ (Global)
Response Mẫu
{
"status": 200,
"success": true,
"data": [
{
"name": "Facebook",
"code": "facebook",
"category": "activation",
"global_qty": 423,
"global_price_vnd": 5593
}
]
}GET
/sms/api/v1/countries
Lấy danh sách quốc gia hỗ trợ
Response Mẫu
{
"status": 200,
"success": true,
"data": [
{
"name": "Vietnam",
"code": "vietnam"
},
{
"name": "USA",
"code": "usa"
}
]
}GET
/sms/api/v1/products/<country_code>/<product_code>
Lấy giá & số lượng theo Quốc gia/Dịch vụ
Params: country_code (e.g., vietnam, any), product_code (e.g., facebook, any).
Response Mẫu
{
"status": 200,
"success": true,
"data": [
{
"country": {
"name": "Vietnam",
"code": "vietnam"
},
"product": {
"name": "Facebook",
"code": "facebook"
},
"qty": 100,
"price_vnd": 5000
}
]
}GET
/sms/api/v1/prices?country=vietnam&product=facebook
Lấy chi tiết giá & Nhà mạng (Operators)
Response Mẫu
{
"status": 200,
"success": true,
"data": {
"country": {
"name": "Vietnam",
"code": "vietnam"
},
"product": {
"name": "Facebook",
"code": "facebook"
},
"operators": [
{
"operator_name": "Viettel",
"operator_code": "viettel",
"cost_vnd": 6000,
"rate": {
"rate": 85.5
}
}
]
}
}GET
/order/api/v1/orders
Lấy danh sách đơn hàng (Lịch sử)
Params: page (default 1), limit (default 10).
Response Mẫu
{
"status": 200,
"success": 1,
"data": [
{
"id": 11,
"created_at": "2025-12-22T09:10:58.477823+07:00",
"status": "timeout",
"phone": "+84376745129",
"price_sell_vnd": 10058,
"currency": "VND",
"country_code": "vietnam",
"country_name": "Vietnam",
"product_code": "facebook",
"product_name": "Facebook",
"operator_code": "virtual4",
"operator_name": "Virtual4",
"expires_at": "2025-12-22T09:25:58.427082+07:00"
},
{
"id": 10,
"created_at": "2025-12-10T14:07:13.294831+07:00",
"status": "canceled",
"phone": "+84817620628",
"price_sell_vnd": 3898,
"currency": "VND",
"country_code": "vietnam",
"country_name": "Vietnam",
"product_code": "tinder",
"product_name": "Tinder",
"operator_code": "virtual47",
"operator_name": "Virtual47",
"expires_at": "2025-12-10T14:22:13.127787+07:00"
}
],
"links": {
"first": "https://api.otpnhanh.net/order/api/v1/orders?page=1&limit=10",
"last": "https://api.otpnhanh.net/order/api/v1/orders?page=1&limit=10",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://api.otpnhanh.net/order/api/v1/orders?page=1&limit=10",
"per_page": 10,
"to": 9,
"total": 9
}
}POST
/order/api/v1/order/buy
Tạo đơn hàng (Mua số)
Body Request
{
"country": "vietnam",
"product": "facebook",
"operator": "viettel"
}Response Mẫu
{
"status": 200,
"success": true,
"data": {
"id": 13753,
"status": "pending",
"phone": "+84912345678",
"price_sell_vnd": 5593,
"expires_at": "2025-12-24T20:48:36..."
}
}GET
/order/api/v1/order/<order_id>
Kiểm tra trạng thái & Lấy Code SMS
Response Mẫu
{
"status": 200,
"success": true,
"data": {
"id": 13753,
"status": "received",
"phone": "+84912345678",
"sms": [
{
"code": "123456",
"message": "Your Facebook code is 123456"
}
]
}
}POST
/order/api/v1/order/<order_id>/cancel
Hủy đơn hàng
Response Mẫu
{
"status": 200,
"success": true,
"data": {
"id": 13753,
"status": "canceled"
}
}