ARNPROXY

Lokasi dan periode

GET/account/api/v1/catalog

Otorisasi

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Izin yang diperlukanread
Acceptapplication/json

Parameter

NamaTipeKeterangan
product_id
queryWajib
integerID produk dari products; 1–2147483647.

Contoh penggunaan tambahan

ID dan harga hanya contoh; gunakan nilai nyata dari katalog dan penawaran yang sama. ID JSON dan expected_total_minor harus berupa angka. Contoh sengaja memakai terms=false; kirim terms=true hanya setelah persetujuan jelas pelanggan untuk operasi berbayar.

Tujuan penggunaan: pilih subtujuan saja

Jangan meminta pelanggan memilih dua tujuan untuk pesanan standar. Temukan id=201 di catalog.purposes dan tampilkan hanya children miliknya. Pada purchase, purpose_id selalu bilangan bulat 201 dan subpurpose_id adalah ID anak yang dipilih. Struktur bertingkat dipertahankan agar integrasi lama tetap kompatibel.

Node.js / JavaScript
const response = await fetch(
  'https://www.arnproxy.com/account/api/v1/catalog?product_id=' + productId,
  { headers: { Authorization: 'Bearer ' + apiKey } }
);
const catalog = await response.json();
if (!response.ok || !catalog.ok) throw new Error('Catalog request failed');
const purposeGroup = catalog.data.purposes.find(group => group.id === 201);
if (!purposeGroup) throw new Error('Purpose group 201 is not available');
const purposeOptions = purposeGroup.children.map(({ id, name }) => ({ id, name }));
// Show only purposeOptions. The customer selects selectedSubpurposeId.
const purchaseLine = {
  location_id: selectedLocationId,
  time_id: selectedTimeId,
  quantity: selectedQuantity,
  purpose_id: 201,
  subpurpose_id: selectedSubpurposeId
};
// Add other_purpose (1–30 characters) only when selectedSubpurposeId === -1.
// No purchase is sent by this example.

Tujuan penggunaan: pilih subtujuan saja

Jangan meminta pelanggan memilih dua tujuan untuk pesanan standar. Temukan id=201 di catalog.purposes dan tampilkan hanya children miliknya. Pada purchase, purpose_id selalu bilangan bulat 201 dan subpurpose_id adalah ID anak yang dipilih. Struktur bertingkat dipertahankan agar integrasi lama tetap kompatibel.

Python
import json
import urllib.request

request = urllib.request.Request(
    'https://www.arnproxy.com/account/api/v1/catalog?product_id=' + str(product_id),
    headers={'Authorization': 'Bearer ' + api_key}
)
with urllib.request.urlopen(request, timeout=20) as response:
    catalog = json.load(response)
if not catalog.get('ok'):
    raise RuntimeError('Catalog request failed')
purpose_group = next((g for g in catalog['data']['purposes'] if g['id'] == 201), None)
if purpose_group is None:
    raise RuntimeError('Purpose group 201 is not available')
purpose_options = [{'id': p['id'], 'name': p['name']} for p in purpose_group['children']]
# Display only purpose_options; the customer selects selected_subpurpose_id.
purchase_line = {
    'location_id': selected_location_id,
    'time_id': selected_time_id,
    'quantity': selected_quantity,
    'purpose_id': 201,
    'subpurpose_id': selected_subpurpose_id,
}
# For Other (-1), also set other_purpose to 1–30 characters.
# This example does not submit a purchase.

Contoh permintaan

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/catalog?product_id=FROM_PRODUCTS'

Contoh tidak dijalankan di halaman ini. Simpan kunci API dalam variabel lingkungan server, bukan URL atau kode browser. Siapkan request.json untuk contoh POST.

Respons

200Respons berhasil
application/json
{
    "ok": true,
    "data": {
        "product": {
            "id": 5,
            "name": "IPv4 Proxy",
            "minimum_quantity": 1
        },
        "currency": "TRY",
        "locations": [
            {
                "id": 10,
                "name": "Example country",
                "periods": [
                    {
                        "id": 101,
                        "name": "7 days",
                        "days": 7,
                        "base_unit_price": "10.0000"
                    }
                ]
            }
        ],
        "purposes": [
            {
                "id": 201,
                "name": "Purpose",
                "children": [
                    {
                        "id": 202,
                        "name": "Example purpose"
                    }
                ]
            }
        ],
        "discount_scope": "country",
        "stock_checked": false,
        "purchase_available": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Kolom dan tipe respons
NamaTipeKeterangan
okbooleanPenanda berhasil; jika false, periksa error.code.
dataobjectHasil khusus operasi; contoh bersifat ilustratif dan sintetis.
data.productobjectNilai khusus operasi untuk product. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.product.idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.product.namestringNilai khusus operasi untuk name. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.product.minimum_quantityintegerJumlah minimum per baris pesanan produk ini.
data.currencystringMata uang transaksi akun: TRY atau USD.
data.locationsarrayNilai khusus operasi untuk locations. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[]objectNilai khusus operasi untuk locations. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[].idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.locations[].namestringNilai khusus operasi untuk name. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[].periodsarrayNilai khusus operasi untuk periods. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[].periods[]objectNilai khusus operasi untuk periods. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[].periods[].idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.locations[].periods[].namestringNilai khusus operasi untuk name. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.locations[].periods[].daysintegerDurasi paket dalam hari, terpisah dari jumlah trafik paket GB.
data.locations[].periods[].base_unit_pricestringNilai khusus operasi untuk base unit price. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposesarrayNilai khusus operasi untuk purposes. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposes[]objectNilai khusus operasi untuk purposes. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposes[].idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.purposes[].namestringNilai khusus operasi untuk name. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposes[].childrenarrayNilai khusus operasi untuk children. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposes[].children[]objectNilai khusus operasi untuk children. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.purposes[].children[].idintegerID catatan ARNPROXY terkait; gunakan alih-alih ID internal penyedia.
data.purposes[].children[].namestringNilai khusus operasi untuk name. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.discount_scopestringNilai khusus operasi untuk discount scope. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
data.stock_checkedbooleanHarga/hasil lokal sendiri bukan jaminan penyedia atau stok.
data.purchase_availablebooleanKetersediaan sesuai syarat/izin, bukan jaminan stok atau penyedia.
metaobjectMetadata korelasi permintaan dan sumber data.
meta.request_idstringID korelasi permintaan HTTP ini, bukan kunci operasi atau ID pesanan.
meta.phasestringNilai khusus operasi untuk phase. Pertahankan tipe yang dikembalikan dan baca catatan perilaku.
meta.sourcestringSumber data; catatan lokal dan kueri penyedia langsung merupakan bukti berbeda.

Respons kesalahan

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Autentikasi dan validasi dapat menolak permintaan sebelum dijalankan. Lihat referensi kesalahan dan simpan request_id untuk dukungan. Jangan kirim kunci atau kata sandi. Kesalahan & batas →

Perilaku & catatan penting

  • Ambil ID dari products/catalog. Baris quote hanya location_id, time_id, quantity. Baris purchase juga wajib purpose_id=201 dan subpurpose_id terpilih.
  • Jangan meminta pelanggan memilih dua tujuan untuk pesanan standar. Temukan id=201 di catalog.purposes dan tampilkan hanya children miliknya. Pada purchase, purpose_id selalu bilangan bulat 201 dan subpurpose_id adalah ID anak yang dipilih. Struktur bertingkat dipertahankan agar integrasi lama tetap kompatibel.
  • Untuk Lainnya, kirim subpurpose_id=-1 serta other_purpose berisi 1–30 karakter. Pilihan lain tidak membutuhkan other_purpose. purpose_id tetap 201.

Cari dalam bahasa saat ini. Tutup dengan Esc