ARNPROXY

Login-Umfang und Optionen

GET/account/api/v1/extra-logins/options

Autorisierung

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Erforderliche Berechtigungproxy_management
Acceptapplication/json

Parameter

NameTypBeschreibung
proxy_ids
queryErforderlich
string1–1000 eindeutige, kommagetrennte Proxy-IDs ohne Leerzeichen: 12345,12346.

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/extra-logins/options?proxy_ids=YOUR_PROXY_ID'

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": {
        "proxy_ids": [
            12345
        ],
        "scope_mode": "order_group",
        "group_change_required": true,
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "creation_available": true,
        "unavailable_reason": null,
        "custom_credentials_available": false,
        "username_length": 8,
        "password_length": 10,
        "primary_credentials_modified": false,
        "authorization_scope": "upstream_order",
        "may_affect_other_proxies": false
    },
    "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.proxy_idsarrayProxy-IDs im für dieses Konto sichtbaren Umfang.
data.proxy_ids[]integerProxy-IDs im für dieses Konto sichtbaren Umfang.
data.scope_modestringAutorisierungsumfang; Bestell-/Paketaktionen können andere Zuordnungen beeinflussen.
data.group_change_requiredbooleanVorgangsspezifischer Wert für group change required. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.revisionstringAktualitätskennung unverändert an die zugehörige Änderung/Preisbestätigung zurückgeben.
data.creation_availablebooleanVerfügbarkeit nach Bedingungen/Berechtigungen; keine Bestands- oder Anbietergarantie.
data.unavailable_reasonstring|nullVorgangsspezifischer Wert für unavailable reason. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.custom_credentials_availablebooleanVorgangsspezifischer Wert für custom credentials available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.username_lengthintegerVorgangsspezifischer Wert für username length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.password_lengthintegerVorgangsspezifischer Wert für password length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.primary_credentials_modifiedbooleanVorgangsspezifischer Wert für primary credentials modified. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.authorization_scopestringAutorisierungsumfang; Bestell-/Paketaktionen können andere Zuordnungen beeinflussen.
data.may_affect_other_proxiesbooleanAndere Zuordnungen können durch den paket-/bestellweiten Umfang betroffen sein.
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

  • Zusätzliche Logins sind vom Hauptlogin getrennt. Ihre Erstellung ändert weder den Hauptlogin noch löscht sie andere zusätzliche Logins. Vor der Erstellung custom_credentials_available, username_length und password_length aus der Optionsantwort lesen.
  • Eine Aktion kann die gesamte Berechtigungsgruppe, etwa eine Bestellung oder ein Paket, betreffen, nicht nur den gewählten Proxy. Vorher proxy_ids, authorization_scope und may_affect_other_proxies prüfen. Bei geändertem Umfang eine neue revision abrufen.

Suche in der aktuellen Sprache. Schließen mit Esc