ARNPROXY

Ülkeler, süreler ve kullanım amaçları

GET/account/api/v1/catalog

Yetkilendirme

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Gerekli izinread
Acceptapplication/json

Parametreler

AdTürAçıklama
product_id
queryZorunlu
integerproducts yanıtındaki ürün ID’si; 1–2147483647.

Ek kullanım örnekleri

Kimlik ve fiyatlar temsilidir; gerçek değerleri katalog ve aynı fiyat yanıtından alın. JSON kimlikleri ve expected_total_minor sayısal olmalıdır. Güvenlik için örneklerde terms=false bırakılmıştır; gerçek ücretli işlem ancak açık müşteri onayıyla terms=true gönderildiğinde başlatılmalıdır.

Kullanım amacı: yalnız alt seçenek seçilir

Normal siparişte iki ayrı seçim yaptırmayın. catalog.purposes içinden id=201 kaydını bulun ve yalnız onun children seçeneklerini gösterin. purchase isteğinde purpose_id sayısal 201 olarak sabittir; subpurpose_id müşterinin seçtiği alt seçeneğin ID’sidir. Katalogdaki üst/alt yapı eski entegrasyonlarla uyumluluk için korunur.

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.

Kullanım amacı: yalnız alt seçenek seçilir

Normal siparişte iki ayrı seçim yaptırmayın. catalog.purposes içinden id=201 kaydını bulun ve yalnız onun children seçeneklerini gösterin. purchase isteğinde purpose_id sayısal 201 olarak sabittir; subpurpose_id müşterinin seçtiği alt seçeneğin ID’sidir. Katalogdaki üst/alt yapı eski entegrasyonlarla uyumluluk için korunur.

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.

İstek örneği

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'

Örnekler bu sayfada çalıştırılmaz. API anahtarını sunucu ortam değişkeninde tutun; gerçek anahtarı URL veya tarayıcı koduna yazmayın. POST örnekleri için request.json hazırlayın.

Yanıtlar

200Başarılı yanıt
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"
    }
}
Yanıt alanları ve türleri
AdTürAçıklama
okbooleanBaşarılı istek zarfı; false ise error.code alanını okuyun.
dataobjectİşleme özel sonuç. Örnekler temsili ve sentetiktir.
data.productobjectproduct alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.product.idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.product.namestringname alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.product.minimum_quantityintegerÜründe sipariş satırı başına uygulanacak asgari adet.
data.currencystringHesabın işlem para birimi: TRY veya USD.
data.locationsarraylocations alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[]objectlocations alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[].idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.locations[].namestringname alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[].periodsarrayperiods alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[].periods[]objectperiods alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[].periods[].idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.locations[].periods[].namestringname alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.locations[].periods[].daysintegerKatalogdaki planın gün sayısı; GB planında kota miktarından ayrıdır.
data.locations[].periods[].base_unit_pricestringbase unit price alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposesarraypurposes alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposes[]objectpurposes alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposes[].idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.purposes[].namestringname alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposes[].childrenarraychildren alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposes[].children[]objectchildren alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.purposes[].children[].idintegerİlgili ARNPROXY kayıt kimliği. Sağlayıcının iç kimliği yerine bunu kullanın.
data.purposes[].children[].namestringname alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.discount_scopestringdiscount scope alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
data.stock_checkedbooleanFiyat/yerel sonuç tek başına sağlayıcı veya stok garantisi değildir.
data.purchase_availablebooleanBu sonuçtaki koşullara/izinlere göre kullanılabilirlik; tek başına stok veya sağlayıcı garantisi değildir.
metaobjectİstek izleme ve veri kaynağı bilgileri.
meta.request_idstringBu HTTP isteğinin kimliği; işlem anahtarı veya sipariş ID’si değildir.
meta.phasestringphase alanının işleme özel değeri; örnekteki türü ve ilgili davranış notlarını esas alın.
meta.sourcestringBu alanın veri kaynağı; yerel kayıt ile canlı sağlayıcı okuması aynı şey değildir.

Hata yanıtı

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

Kimlik doğrulama ve alan denetimleri işlemi başlamadan reddedebilir. Hata rehberini inceleyin; destek için request_id saklayın. Anahtar veya şifre göndermeyin. Hatalar ve limitler →

Davranış ve önemli notlar

  • Tüm kimlikleri products/catalog yanıtından alın. quote satırları yalnız location_id, time_id ve quantity içerir. purchase satırında purpose_id=201 ve seçilen subpurpose_id ayrıca zorunludur.
  • Normal siparişte iki ayrı seçim yaptırmayın. catalog.purposes içinden id=201 kaydını bulun ve yalnız onun children seçeneklerini gösterin. purchase isteğinde purpose_id sayısal 201 olarak sabittir; subpurpose_id müşterinin seçtiği alt seçeneğin ID’sidir. Katalogdaki üst/alt yapı eski entegrasyonlarla uyumluluk için korunur.
  • “Diğer” seçilirse subpurpose_id=-1 ve 1–30 karakterlik other_purpose gönderin. Diğer seçimlerde other_purpose gerekmez. purpose_id yine 201’dir.

Geçerli dilde arar. Kapatmak için Esc