archive/load

Liefert als Ergebnis eine URL, die ins Tool führt und das Archiv zur übergebenen Transaktions-Id lädt.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/archive/load

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/archive/load/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/archive/load/validate


property default description options
[ token ] * required
string
Token für die Authentifizierung mit der Schnittstelle
[ separate_token ]
bool
false
Steuert, ob der Token als separates Feld zurückgegeben wird oder in der aufzurufenden Url enthalten ist. Standardmäßig wird er in der Url zurückgegeben.
[ transaction_id ] * required
string
gültige Transaktions-Id
[ keep_transaction_id ]
bool
true
Transaktions-Id aus dem Archiv weiter verwenden?
[ publisher_subscribe_url ]
string
URL die bei bestimmten Aktionen, welche der Anwender in der Oberfläche ausführt, per POST aufgerufen wird.
Hier klicken für weitere Details...
[ exit_url ]
string
URL, welche beim Verlassen des Tools per Redirect (HTTP 302) aufgerufen wird.
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "separate_token": true,
    "transaction_id": "2f439e15b2ad44c4811047bfc09337b43d0cf3c5",
    "keep_transaction_id": true,
    "publisher_subscribe_url": "https:\/\/www.external-target.com\/",
    "exit_url": "https:\/\/www.external-target.com\/"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "transaction_id": "2f439e15b2ad44c4811047bfc09337b43d0cf3c5"
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/archive/load/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft
[ errors ]
string[]
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!
[ accessurl ]
string
aufzurufende URL
[ token ]
string
Token zur Authentifizierung
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "accessurl": "https:\/\/Toolname.de\/Bereich\/index.php?token=...",
    "token": "0123456789abcdefghijklmnop"
}