ARNPROXY

Login-Vorgang prüfen

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

Autorisierung

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Erforderliche Berechtigungproxy_management
Acceptapplication/json
Idempotency-Key16–100 Buchstaben, Ziffern, _ oder -. Für denselben Vorgang speichern und wiederverwenden.

Parameter

NameTypBeschreibung
Idempotency-Key
headerErforderlich
string16–100 Buchstaben/Ziffern/_/-. Für Vorgang und Status denselben Wert behalten; nicht mit anderem Inhalt wiederverwenden.

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 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    'https://www.arnproxy.com/account/api/v1/extra-logins/status'

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": {
        "state": "completed",
        "action": "create",
        "login_id": 40001,
        "proxy_ids": [
            12345
        ],
        "reason_code": null,
        "resume_available": false,
        "replayed": true,
        "credentials_included": false,
        "primary_credentials_modified": 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.statestringDatensatz-/Vorgangsstatus. accepted bedeutet nicht geliefert, completed keinen Verbindungstest.
data.actionstringVorgangsspezifischer Wert für action. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.login_idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.proxy_idsarrayProxy-IDs im für dieses Konto sichtbaren Umfang.
data.proxy_ids[]integerProxy-IDs im für dieses Konto sichtbaren Umfang.
data.reason_codestring|nullFester Grundcode oder null, niemals ungefilterter Anbieterfehlertext.
data.resume_availablebooleanAusdrückliche Fortsetzungsmöglichkeit für einen ungesendeten Schritt; bei false nicht automatisch wiederholen.
data.replayedbooleanGespeichertes Ergebnis desselben Vorgangs, kein Beweis für neue Abbuchung/Aktion.
data.credentials_includedbooleanOb Ergebnis/Schlüssel sensible Zugangsdaten enthält oder erlaubt.
data.primary_credentials_modifiedbooleanVorgangsspezifischer Wert für primary credentials modified. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
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