ProxyLite OpenAPI
Kunci autentikasi app_key dapat dilihat di halaman beranda pusat pribadi setelah login.
Harap simpan kunci dengan aman, kunci memiliki hak administrator akun Anda.
Base URLs:
https://api.proxylite.com
Metode Autentikasi
Autentikasi App Key
Parameter POST:
app_key: {your_app_key}
Atau sebagai parameter query:
?app_key={your_app_key}
Format Respons
Semua interface mengembalikan format JSON yang seragam:
{
"code": 200,
"message": "操作成功",
"data": {}
}
code: Kode status, 200 menunjukkan sukses, nilai lain menunjukkan gagalmessage: Pesan respons (Bahasa Mandarin)data: Data respons
Authentication
Interface ini mendukung dua metode autentikasi berikut:
1. Bearer Token (JWT)
Meneruskan Token melalui HTTP Header.
Contoh Header:
Authorization: Bearer <your_jwt_token>
Autentikasi API Key
Interface ini menggunakan metode API Key untuk verifikasi identitas.
Klien perlu membawa parameter app_key dalam permintaan, jika tidak permintaan akan ditolak.
Contoh:
GET /api/example?app_key=your_app_key
POST /api/example?app_key=your_app_key
Content-Type: application/json
Manajemen Akun Proxy
GET Daftar Akun Proxy
GET /end-point/whitelist-account/list
Contoh Respons
Respons Berhasil (200)
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"id": 0,
"username": "string",
"password": "string",
"created_at": "string",
"remark": "string",
"product_type": 9,
"usage_flow": 0,
"limit_flow": 102400,
"status": 0
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | responseCode | false | none | Kode status, 200 sukses, 3 app_key tidak valid | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» id | integer | false | none | Nomor akun | |
| »»» username | string | false | none | Nama akun proxy | |
| »»» password | string | false | none | Kata sandi akun proxy | |
| »»» created_at | string | false | none | Waktu penambahan | |
| »»» remark | string | false | none | Catatan | |
| »»» product_type | productTypes | false | none | Jenis paket, 9 Paket traffic residensial dinamis, 11 IP residensial dinamis, 14 IP data center statis, 25 IP residensial statis | |
| »»» usage_flow | integer | false | none | Traffic yang digunakan, satuan: KB | |
| »»» limit_flow | integer | false | none | Batas traffic kustom: satuan GB maksimal 102400, 0 tidak terbatas | |
| »»» status | integer | false | none | Status aktif: 1 aktif, 0 nonaktif |
Nilai Enumerasi
| Atribut | Nilai |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
POST Tambah Akun Proxy
POST /end-point/whitelist-account/add
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01:pass,user02:pass,user03:pass",
"remark": "",
"product_type": 9
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » accounts | body | string | Tidak | Akun dan kata sandi, harap isi sesuai format username:password, akun dan kata sandi hanya mendukung angka dan huruf, dilarang memasukkan simbol khusus atau spasi, pisahkan akun dan kata sandi dengan titik dua. Mendukung penambahan batch, pisahkan akun proxy dengan koma (,). |
| » remark | body | string | Tidak | Deskripsi akun proxy |
| » product_type | body | productTypes | Tidak | Jenis paket, 9 Paket traffic residensial dinamis, 11 IP residensial dinamis, 14 IP data center statis, 25 IP residensial statis |
Nilai Enumerasi
| Atribut | Nilai |
|---|---|
| » product_type | 9 |
| » product_type | 11 |
| » product_type | 14 |
| » product_type | 25 |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Hapus Akun Proxy
POST /end-point/whitelist-account/delete
Harap perhatikan bahwa setelah dihapus tidak dapat dipulihkan, traffic yang telah digunakan dan lainnya tidak dapat ditanyakan. Penghapusan memiliki waktu tunggu sekitar 5 menit, selama periode ini masih mungkin terjadi biaya.
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » accounts | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. Mendukung operasi batch, pisahkan akun proxy dengan koma (,) |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Nonaktifkan Akun Proxy
POST /end-point/whitelist-account/disable
Penonaktifan memiliki waktu tunggu sekitar 5 menit, selama periode ini masih mungkin terjadi biaya.
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » accounts | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. Mendukung operasi batch, pisahkan akun proxy dengan koma (,) |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Aktifkan Akun Proxy
POST /end-point/whitelist-account/enable
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"accounts": "user01,user02"
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » accounts | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. Mendukung operasi batch, pisahkan akun proxy dengan koma (,) |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Ubah Kata Sandi Akun Proxy
POST /end-point/whitelist-account/change-password
Harap perhatikan bahwa setelah diubah ada waktu tunggu 5 menit, selama periode ini kata sandi lama masih mungkin digunakan secara normal.
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"password": "pass"
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » account | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. |
| » password | body | string | Tidak | Kata sandi baru akun proxy, hanya mendukung angka dan huruf. |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Ubah Catatan Akun Proxy
POST /end-point/whitelist-account/change-remark
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"remark": ""
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » account | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. |
| » remark | body | string | Tidak | Catatan baru akun proxy, dalam 32 karakter Mandarin atau 64 karakter Inggris. |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
POST Ubah Batas Traffic Akun Proxy
POST /end-point/whitelist-account/change-limit
Harap perhatikan bahwa statistik traffic mungkin memiliki penundaan dalam 5 menit, yaitu konsumsi traffic aktual mungkin melebihi batas ini.
Parameter Permintaan Body
{
"app_key": "stringstringstringstringstringst",
"account": "user",
"limit": 0
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Tidak | none |
| » app_key | body | string | Tidak | Kunci otorisasi |
| » account | body | string | Tidak | Akun proxy, hanya mendukung angka dan huruf. |
| » limit | body | integer | Tidak | Batas traffic, satuan: GB, 0 untuk tidak ada batas |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": null
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | null | false | none | none |
Kueri Log Traffic
GET Ringkasan Penggunaan Traffic Harian
GET /end-point/user-usage-flow/total
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| app_key | query | string(password) | Ya | Kunci autentikasi |
| start_time | query | string(Y-m-d H:i:s) | Tidak | Waktu mulai, dapat akurat hingga detik. Harap perhatikan, pencatatan log memiliki penundaan dalam 5 menit. Default dalam 7 hari. |
| end_time | query | string(Y-m-d H:i:s) | Tidak | Waktu akhir, dapat akurat hingga detik. Harap perhatikan, pencatatan log memiliki penundaan dalam 5 menit. Default waktu saat ini. |
| username | query | string | Tidak | Nama sub-akun, default kueri semua akun, dapat menentukan sub-akun. Harap perhatikan jika Anda menambahkan sub-akun dengan nama yang sama, kueri ini akan mengembalikan semua catatan penggunaan akun proxy dengan nama yang sama. |
| product_type | query | number | Tidak | Jenis paket |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"day": "2022-08-01",
"flow": 0
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» day | string | false | none | Tanggal | |
| »»» flow | integer | false | none | Traffic yang dikonsumsi, satuan KB |
Kueri Paket
GET Daftar Paket yang Dibeli
GET /end-point/user-product/list
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| app_key | query | string(password) | Ya | Kunci autentikasi |
| trade_no | query | string | Tidak | Nomor pesanan, harap masukkan nomor pesanan lengkap. Tidak mendukung pencarian fuzzy. |
| page | query | number | Tidak | Paginasi, default: 1 |
| size | query | number | Tidak | Jumlah tampilan paginasi, default: 20 |
| product_type | query | number | Tidak | Jenis paket |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"id": 0,
"created_at": "2022-05-13 12:14:15",
"expired_at": "2022-05-13 12:14:15",
"product_type": 9,
"trade_no": "2022051312134339861461465434",
"order": {
"created_at": "2022-05-13 12:13:43",
"pay_at": "2022-05-13 12:13:43",
"title": "入门级"
}
}
],
"page": 1,
"page_size": 20,
"total_count": 0,
"total_page": 0
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» id | integer | false | none | Nomor paket | |
| »»» created_at | string | false | none | Waktu efektif paket | |
| »»» expired_at | string | false | none | Waktu kedaluwarsa paket, traffic tidak dapat digunakan setelah kedaluwarsa. | |
| »»» product_type | productTypes | false | none | Jenis paket, 9 Paket traffic residensial dinamis, 11 IP residensial dinamis, 14 IP data center statis, 25 IP residensial statis | |
| »»» trade_no | string | false | none | Nomor transaksi pesanan | |
| »»» order | object | false | none | none | |
| »»»» created_at | string | false | none | Waktu pembuatan pesanan | |
| »»»» pay_at | string | false | none | Waktu pembayaran pesanan | |
| »»»» title | string | false | none | Deskripsi pesanan | |
| »» page | integer | false | none | Paginasi saat ini | |
| »» page_size | integer | false | none | Ukuran paginasi | |
| »» total_count | integer | false | none | Jumlah total catatan | |
| »» total_page | integer | false | none | Jumlah total halaman |
Nilai Enumerasi
| Atribut | Nilai |
|---|---|
| product_type | 9 |
| product_type | 11 |
| product_type | 14 |
| product_type | 25 |
Ekstraksi IP
GET Ekstrak IP
GET /end-point/ip/v3
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| app_key | query | string(password) | Tidak | Kunci akses |
| cc | query | string | Tidak | Negara atau wilayah |
| state | query | string | Tidak | Provinsi atau negara bagian |
| city | query | string | Tidak | Kota |
| format | query | string | Tidak | Format pengambilan |
| lb | query | string | Tidak | Pemisah, hanya berlaku untuk format text |
| num | query | number | Tidak | Jumlah ekstraksi |
| life | query | number | Tidak | Siklus pemeliharaan - menit |
| ep | query | string | Tidak | Jaringan proxy |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
[
"150.109.114.72:1140",
"150.109.114.72:1141",
"150.109.114.72:1142",
"150.109.114.72:1143",
"150.109.114.72:1144",
"150.109.114.72:1145",
"150.109.114.72:1146",
"150.109.114.72:1147",
"150.109.114.72:1148",
"150.109.114.72:1149"
]
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [any] | false | none | none |
GET Daftar Kota
GET /end-point/ip/dynamic-citys
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"name_zh_cn": "美国",
"name_en": "United States",
"continent_code": "NA",
"country_code": "US",
"items": [
{
"city": null,
"state": null,
"continent_code": null,
"country_code": null
}
]
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | Daftar | |
| »»» name_zh_cn | string | false | none | Nama negara atau wilayah | |
| »»» name_en | string | false | none | Nama negara atau wilayah | |
| »»» continent_code | string | false | none | Kode benua | |
| »»» country_code | string | false | none | Kode negara atau wilayah | |
| »»» items | [object] | false | none | Provinsi atau negara bagian | |
| »»»» city | string | false | none | Nama kota | |
| »»»» state | string | false | none | Kode nama provinsi atau negara bagian | |
| »»»» continent_code | string | false | none | Kode benua | |
| »»»» country_code | string | false | none | Kode negara atau wilayah |
GET Pencarian Kota
GET /end-point/ip/dynamic-citys/search
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| country_code | query | string | Ya | Kode negara atau wilayah |
| state | query | string | Ya | Kode negara bagian atau provinsi |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": ["string"]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [string] | false | none | Daftar |
GET Daftar Negara Bagian
GET /end-point/ip/dynamic-states
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": [
{
"name_zh_cn": "美国",
"name_en": "United States",
"continent_code": "NA",
"country_code": "US",
"items": [
{
"state": null,
"continent_code": null,
"country_code": null
}
]
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | Daftar | |
| »»» name_zh_cn | string | false | none | Nama negara atau wilayah | |
| »»» name_en | string | false | none | Nama negara atau wilayah | |
| »»» continent_code | string | false | none | Kode benua | |
| »»» country_code | string | false | none | Kode negara atau wilayah | |
| »»» items | [object] | false | none | Provinsi atau negara bagian | |
| »»»» state | string | false | none | Kode nama provinsi atau negara bagian | |
| »»»» continent_code | string | false | none | Kode benua | |
| »»»» country_code | string | false | none | Kode negara atau wilayah |
GET Pencarian Negara Bagian/Provinsi
GET /end-point/ip/dynamic-states/search
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| country_code | query | string | Ya | Kode negara atau wilayah |
Contoh Respons
200 Response
{
"code": 200,
"msg": "string",
"data": {
"list": ["string"]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Permintaan sukses | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [string] | false | none | Daftar |
GET Ekstrak Daftar IP Statis yang Dibeli
GET /end-point/ip/get-static-ip
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| country_code | query | string | Tidak | Kode negara atau wilayah |
| product_type | query | number | Tidak | Jenis produk, 25: IP residensial statis, 14: IP data center |
| trade_no | query | string | Tidak | Filter IP berdasarkan nomor pesanan |
| page | query | number | Tidak | Nomor halaman |
| size | query | number | Tidak | Jumlah per halaman |
| status | query | number | Tidak | Status, 1: valid, 2: tidak valid, 3: akan kedaluwarsa, 4: dalam pemeliharaan |
Nilai Enumerasi
| Atribut | Nilai |
|---|---|
| product_type | 14 |
| product_type | 25 |
| status | 1 |
| status | 2 |
| status | 3 |
| status | 4 |
Contoh Respons
200 Response
{}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | none | Inline |
Struktur Data Respons
GET Dapatkan Jumlah IP Statis Wilayah yang Dijual
GET /end-point/static-ip-region
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| isp | query | string | Tidak | Jenis IP |
Penjelasan Jenis IP
| Jenis IP | Deskripsi |
|---|---|
| 1 | IP statis residensial rumah |
| 0 | IP statis data center |
Contoh Respons
200 Response
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"code": "US",
"number": 55
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | none | Inline |
Struktur Data Respons
Kode Status 200
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» list | [object] | false | none | none | |
| »»» code | string | false | none | Kode negara atau wilayah | |
| »»» number | integer | false | none | Jumlah |
Manajemen Pesanan
GET Daftar Pesanan
GET /end-point/order/list
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| page_no | query | integer | Tidak | none |
| page_size | query | integer | Tidak | none |
| trade_no | query | string | Tidak | Nomor pesanan |
| status | query | integer | Tidak | Status pesanan |
| product_type | query | integer | Tidak | Jenis produk |
Penjelasan Detail
status: Status pesanan
| Status | Deskripsi |
|---|---|
| 0 | Menunggu pembayaran |
| 1 | Sudah dibayar |
| 2 | Dibatalkan karena timeout |
| 3 | Sudah direfund |
product_type: Jenis produk
| Jenis Produk | Deskripsi |
|---|---|
| 3 | Isi ulang saldo |
| 9 | Paket traffic dinamis |
| 11 | Paket global dinamis per waktu V2 |
| 12 | Paket traffic IDC jangka panjang |
| 13 | Paket traffic IP statis residensial |
| 14 | Paket IP statis data center |
| 15 | Paket traffic ISP jangka panjang |
| 16 | Paket traffic statis |
| 17 | Paket jumlah IP dinamis |
| 18 | web-scraper |
| 19 | Perpanjangan IP statis |
| 20 | Kuota penggantian IP statis |
| 21 | Paket traffic statis v2 |
| 24 | Paket tambahan traffic statis |
| 25 | Paket IP statis residensial |
| 26 | Pesanan tambahan - Beberapa saluran pembayaran memerlukan pengguna mengisi jumlah secara manual, seperti: cryptocurrency, jika terjadi kekurangan pembayaran, perlu menghubungi layanan pelanggan untuk melakukan pembayaran tambahan melalui produk ini |
| 27 | Serp |
| 28 | Video |
Nilai Enumerasi
| Atribut | Nilai |
|---|---|
| status | 0 |
| status | 1 |
| status | 2 |
| status | 3 |
| product_type | 3 |
| product_type | 9 |
| product_type | 11 |
| product_type | 12 |
| product_type | 14 |
| product_type | 16 |
| product_type | 17 |
| product_type | 18 |
| product_type | 19 |
| product_type | 21 |
| product_type | 24 |
| product_type | 25 |
| product_type | 26 |
| product_type | 27 |
| product_type | 28 |
Contoh Respons
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"list": [
{
"id": 0,
"trade_no": "string",
"product_id": 0,
"product_name": "string",
"total_fee": 0.1,
"pay_fee": 0.1,
"status": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"total": 0,
"page_no": 0,
"page_size": 0,
"total_pages": 0
}
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Sukses | Inline |
Struktur Data Respons
POST Buat Pesanan
POST /end-point/order/create
Karena jenis paket cukup banyak, dan setiap paket memiliki konfigurasi yang berbeda, harap isi parameter sesuai situasi aktual. Pengisian parameter yang tidak tepat dapat menyebabkan pembuatan pesanan gagal.
Contoh:
Perpanjangan IP Statis
{
"pid": x, // Hubungi layanan pelanggan untuk mendapatkan
"upids": "1,2,3,4,5,6", // Dapatkan ID yang sesuai dari /end-point/ip/get-static-ip
"pm_id": 1 // Dapatkan dari /end-point/payment/list
"coupon_sn: "xxx", // Opsional - Kupon
}
Parameter Permintaan Body
{
"pid": 0,
"upids": "string",
"amount": 0,
"pm_id": 0,
"region_list": "string",
"coupon_sn": "string",
"use_invitation_registration_discount": true,
"renew_duration": 0,
"product_sku_bandwidth_id": 0,
"product_sku_concurrency_id": 0,
"recharge_amount": 0
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Ya | none |
| » pid | body | integer | Ya | ID paket |
| » upids | body | string | Tidak | Daftar ID paket perpanjangan |
| » amount | body | number | Tidak | Jumlah paket baru |
| » pm_id | body | integer | Ya | ID metode pembayaran |
| » region_list | body | string | Tidak | Tentukan wilayah + jumlah saat membeli IP statis |
| » coupon_sn | body | string | Tidak | Nomor kupon |
| » use_invitation_registration_discount | body | boolean | Tidak | Apakah menggunakan diskon registrasi undangan |
| » renew_duration | body | integer | Tidak | Durasi perpanjangan - opsional untuk IP statis |
| » product_sku_bandwidth_id | body | integer | Tidak | Paket 11: ID paket bandwidth |
| » product_sku_concurrency_id | body | integer | Tidak | Paket 11: ID paket konkurensi |
| » recharge_amount | body | integer | Tidak | Paket 3: Jumlah isi ulang |
Contoh Respons
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"id": 0,
"trade_no": "string",
"product_id": 0,
"product_name": "string",
"total_fee": 0.1,
"pay_fee": 0.1,
"status": 0,
"created_at": "2019-08-24T14:15:22Z"
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Berhasil dibuat | Inline |
Struktur Data Respons
POST Batalkan Pesanan
POST /end-point/order/close
Parameter Permintaan Body
{
"trade_no": "string"
}
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| body | body | object | Ya | none |
| » trade_no | body | string | Ya | none |
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Operasi sukses | None |
Manajemen Pengguna
GET Dapatkan Informasi Pengguna - Belum Dibuka
GET /end-point/user/info
Contoh Respons
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"id": 0,
"email": "[email protected]",
"phone": "string",
"balance": 0.1,
"status": 0,
"is_real_name": true,
"created_at": "2019-08-24T14:15:22Z"
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Sukses | Inline |
Struktur Data Respons
Manajemen Pembayaran
GET Dapatkan Daftar Metode Pembayaran
GET /end-point/payment/groups
Parameter Permintaan
| Nama | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| trade_no | query | string | Tidak | Nomor pesanan - dapat dikirim saat beberapa pesanan perlu mendapatkan metode pembayaran tertentu |
Contoh Respons
200 Response
{
"code": 0,
"message": "操作成功",
"data": {
"list": [
{
"name": "支付方式分组",
"logos": ["https://example.com/logo1.png", "https://example.com/logo2.png"],
"items": [
{
"id": 1,
"title": "title1",
"logo": "https://example.com/logo1.png",
"group": "online",
"disabled": false,
"min": 10,
"max": 5000
}
]
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | Berhasil didapatkan | Inline |
Struktur Data Respons
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| »» name | string | false | none | Nama grup | |
| »» logos | string[] | false | none | Daftar ikon grup | |
| »» items | object[] | false | none | Daftar item dalam grup | |
| »»» id | integer | false | none | ID metode pembayaran | |
| »»» title | string | false | none | Nama metode pembayaran | |
| »»» logo | string | false | none | Logo metode pembayaran | |
| »»» group | string | false | none | Identifikasi grup metode pembayaran | |
| »»» disabled | boolean | false | none | Apakah dinonaktifkan (default false) | |
| »»» min | number | false | none | Jumlah minimum | |
| »»» max | number | false | none | Jumlah maksimum |
Pemasaran
GET Rasio Bonus Isi Ulang
GET /end-point/activity/balance-recharge-gift-ratio
Rasio bonus isi ulang
Contoh Respons
200 Response
{
"code": 0,
"msg": "操作成功",
"data": {
"list": [
{
"amount": 100,
"ratio": 1.2
}
]
}
}
Hasil Respons
| Kode Status | Arti Kode Status | Keterangan | Model Data |
|---|---|---|---|
| 200 | OK | OK | Inline |
Struktur Data Respons
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| » code | integer | false | none | Kode status, 200 sukses, 3 app_key tidak valid, 156 akun belum verifikasi nama asli | |
| » msg | string | false | none | Pesan status | |
| » data | object | false | none | none | |
| » list | [object] | false | none | none | |
| »» amount | integer | false | none | Jumlah isi ulang | |
| »» ratio | number | false | none | Rasio isi ulang |
Penjelasan Struktur Data (Schemas)
productTypes (Jenis Paket)
| Field | Tipe | Keterangan |
|---|---|---|
| product_type | integer | Jenis paket |
Penjelasan Nilai Opsional:
| Nilai | Arti |
|---|---|
| 9 | Paket traffic residensial dinamis |
| 11 | IP residensial dinamis |
| 14 | IP data center statis |
| 25 | IP residensial statis |
API Key (Kunci Autentikasi)
Digunakan untuk autentikasi identitas interface, harap dikirim melalui parameter Query.
| Nama Parameter | Lokasi | Tipe | Wajib | Keterangan |
|---|---|---|---|---|
| app_key | query | string | Ya | Kunci autentikasi |
Field Respons Umum
responseCode
| Field | Tipe | Contoh | Keterangan |
|---|---|---|---|
| code | integer | 200 | Kode status (200 sukses, 3 menunjukkan app_key tidak valid) |
responseMsg
| Field | Tipe | Contoh | Keterangan |
|---|---|---|---|
| message | string | success | Pesan respons |
Respons Sukses (SuccessResponse)
{
"code": 0,
"message": "操作成功",
"data": {}
}
Respons Error (ErrorResponse)
{
"code": 400,
"message": "参数错误",
"errors": {}
}
User
{
"id": 0,
"email": "[email protected]",
"phone": "string",
"balance": 0.1,
"status": 0,
"is_real_name": true,
"created_at": "2019-08-24T14:15:22Z"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| string(email) | false | none | none | ||
| phone | string | false | none | none | |
| balance | number(float) | false | none | none | |
| status | integer | false | none | none | |
| is_real_name | boolean | false | none | none | |
| created_at | string(date-time) | false | none | none |
Order
{
"id": 0,
"trade_no": "string",
"product_id": 0,
"product_name": "string",
"total_fee": 0.1,
"pay_fee": 0.1,
"status": 0,
"created_at": "2019-08-24T14:15:22Z"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| trade_no | string | false | none | none | |
| product_id | integer | false | none | none | |
| product_name | string | false | none | none | |
| total_fee | number(float) | false | none | none | |
| pay_fee | number(float) | false | none | none | |
| status | integer | false | none | none | |
| created_at | string(date-time) | false | none | none |
Product
{
"id": 0,
"name": "string",
"type": 0,
"price": 0.1,
"description": "string"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| name | string | false | none | none | |
| type | integer | false | none | none | |
| price | number(float) | false | none | none | |
| description | string | false | none | none |
WhiteIp
{
"id": 0,
"ip": "string",
"remark": "string",
"created_at": "2019-08-24T14:15:22Z"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| ip | string | false | none | none | |
| remark | string | false | none | none | |
| created_at | string(date-time) | false | none | none |
WhitelistAccount
{
"id": 0,
"username": "string",
"limit": 0,
"used": 0,
"status": 0
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| username | string | false | none | none | |
| limit | integer | false | none | none | |
| used | integer | false | none | none | |
| status | integer | false | none | none |
Coupon
{
"id": 0,
"name": "string",
"code": "string",
"discount": 0.1,
"expire_time": "2019-08-24T14:15:22Z"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| name | string | false | none | none | |
| code | string | false | none | none | |
| discount | number(float) | false | none | none | |
| expire_time | string(date-time) | false | none | none |
Article
{
"id": 0,
"title": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z"
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| id | integer | false | none | none | |
| title | string | false | none | none | |
| content | string | false | none | none | |
| created_at | string(date-time) | false | none | none |
Pagination
{
"total": 0,
"page_no": 0,
"page_size": 0,
"total_pages": 0
}
| Nama | Tipe | Wajib | Batasan | Nama Mandarin | Keterangan |
|---|---|---|---|---|---|
| total | integer | false | none | none | |
| page_no | integer | false | none | none | |
| page_size | integer | false | none | none | |
| total_pages | integer | false | none | none |