ARNPROXY

Standorte und Laufzeiten

GET/account/api/v1/catalog

Autorisierung

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Erforderliche Berechtigungread
Acceptapplication/json

Parameter

NameTypBeschreibung
product_id
queryErforderlich
integerProdukt-ID aus products; 1–2147483647.

Weitere Anwendungsbeispiele

IDs und Preise sind beispielhaft; verwenden Sie echte Werte aus dem Katalog und demselben Angebot. JSON-IDs und expected_total_minor müssen Zahlen sein. Beispiele verwenden bewusst terms=false. Senden Sie terms=true nur nach ausdrücklicher Zustimmung zur kostenpflichtigen Aktion.

Verwendungszweck: nur Unterzweck auswählen

Verlangen Sie bei einer Standardbestellung keine zwei Auswahlen. Suchen Sie id=201 in catalog.purposes und zeigen Sie nur dessen children an. Bei purchase ist purpose_id die feste Ganzzahl 201; subpurpose_id ist die ID des gewählten Unterzwecks. Die Hierarchie bleibt für bestehende Integrationen erhalten.

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.

Verwendungszweck: nur Unterzweck auswählen

Verlangen Sie bei einer Standardbestellung keine zwei Auswahlen. Suchen Sie id=201 in catalog.purposes und zeigen Sie nur dessen children an. Bei purchase ist purpose_id die feste Ganzzahl 201; subpurpose_id ist die ID des gewählten Unterzwecks. Die Hierarchie bleibt für bestehende Integrationen erhalten.

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.

Anfragebeispiel

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'

Beispiele werden hier nicht ausgeführt. Speichern Sie den API-Schlüssel in einer serverseitigen Umgebungsvariablen, nie in URLs oder Browsercode. Bereiten Sie request.json für POST vor.

Antworten

200Erfolgsantwort
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"
    }
}
Antwortfelder und Typen
NameTypBeschreibung
okbooleanErfolgskennzeichen; bei false error.code prüfen.
dataobjectVorgangsspezifisches Ergebnis; Beispiele sind synthetisch und dienen der Veranschaulichung.
data.productobjectVorgangsspezifischer Wert für product. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.product.idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.product.namestringVorgangsspezifischer Wert für name. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.product.minimum_quantityintegerMindestmenge je Bestellzeile dieses Produkts.
data.currencystringKontowährung der Transaktion: TRY oder USD.
data.locationsarrayVorgangsspezifischer Wert für locations. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[]objectVorgangsspezifischer Wert für locations. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[].idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.locations[].namestringVorgangsspezifischer Wert für name. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[].periodsarrayVorgangsspezifischer Wert für periods. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[].periods[]objectVorgangsspezifischer Wert für periods. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[].periods[].idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.locations[].periods[].namestringVorgangsspezifischer Wert für name. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.locations[].periods[].daysintegerLaufzeit in Tagen, getrennt vom Trafficvolumen des GB-Plans.
data.locations[].periods[].base_unit_pricestringVorgangsspezifischer Wert für base unit price. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposesarrayVorgangsspezifischer Wert für purposes. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposes[]objectVorgangsspezifischer Wert für purposes. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposes[].idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.purposes[].namestringVorgangsspezifischer Wert für name. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposes[].childrenarrayVorgangsspezifischer Wert für children. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposes[].children[]objectVorgangsspezifischer Wert für children. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.purposes[].children[].idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.purposes[].children[].namestringVorgangsspezifischer Wert für name. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.discount_scopestringVorgangsspezifischer Wert für discount scope. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.stock_checkedbooleanPreis/lokales Ergebnis allein garantiert weder Anbieter noch Bestand.
data.purchase_availablebooleanVerfügbarkeit nach Bedingungen/Berechtigungen; keine Bestands- oder Anbietergarantie.
metaobjectMetadaten zu Anfragezuordnung und Datenquelle.
meta.request_idstringKennung dieser HTTP-Anfrage, kein Vorgangsschlüssel oder Bestell-ID.
meta.phasestringVorgangsspezifischer Wert für phase. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
meta.sourcestringDatenquelle; lokale Datensätze und Live-Anbieterabfragen sind unterschiedliche Nachweise.

Fehlerantwort

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

Authentifizierung und Validierung können eine Anfrage vor der Ausführung ablehnen. Beachten Sie die Fehlerreferenz und bewahren Sie request_id für den Support auf. Senden Sie niemals Schlüssel oder Passwörter. Fehler & Limits →

Verhalten & wichtige Hinweise

  • IDs aus products/catalog übernehmen. quote-Zeilen enthalten nur location_id, time_id, quantity. purchase erfordert zusätzlich purpose_id=201 und gewählte subpurpose_id.
  • Verlangen Sie bei einer Standardbestellung keine zwei Auswahlen. Suchen Sie id=201 in catalog.purposes und zeigen Sie nur dessen children an. Bei purchase ist purpose_id die feste Ganzzahl 201; subpurpose_id ist die ID des gewählten Unterzwecks. Die Hierarchie bleibt für bestehende Integrationen erhalten.
  • Für Sonstiges senden Sie subpurpose_id=-1 und other_purpose mit 1–30 Zeichen. Bei anderen Auswahlen ist other_purpose nicht erforderlich. purpose_id bleibt 201.

Suche in der aktuellen Sprache. Schließen mit Esc