404, bis der Live-Zugang angekündigt wird, und in der Sandbox fallen keine Kosten an.
Diese Schnellstartanleitung führt Sie mit kopierbaren Anfragen von einer Sandbox-Anwendung zu den Konten, Guthaben und Transaktionen der Didit Test Bank.
Jede Antwort unten ist auf die wichtigen Felder gekürzt.
Bewahren Sie den API-Schlüssel auf Ihrem Server auf: Er gelangt nie in einen Browser oder in eine App.
Schritt 1: API-Schlüssel mit der Berechtigung für Bank data erstellen
Bank data ist nicht im Vollzugriff enthalten. Ein Schlüssel mit Vollzugriff, einschließlich des primären Geheimnisses der Anwendung, wird bei jedem Aufruf für Bank data mit403 bank_data_access_denied abgelehnt.
- Öffnen Sie in der Business Console Ihre Sandbox-Anwendung und gehen Sie zu API keys.
- Erstellen Sie einen Schlüssel mit benutzerdefiniertem Zugriff und fügen Sie Bank data hinzu: Read für die Lesezugriffe, Write für die Aufrufe, die etwas erstellen, ändern oder löschen.
- Kopieren Sie den Schlüssel und exportieren Sie ihn:
Schritt 2: Link erstellen
Ein Link ist ein Durchlauf der Bildschirme, über die eine Person eine Bank verbindet. Erstellen Sie einen dauerhaften Link für die Test-Bank:country ist der dreistellige Ländercode der Bank der Person und ist optional.
Senden Sie ihn, wenn Sie ihn kennen, damit die Person nur die Banken dieses Landes sieht. Ohne ihn wählt die Person aus allen Ländern, die Sie bedienen können.
Für einmaligen Zugriff senden Sie "access": "one_time" (Standardwert).
id bei Ihrem Benutzer.
url und client_token werden nur einmal zurückgegeben, und zwar bei der Erstellung des Links.
Schritt 3: Link öffnen und Didit Test Bank verbinden
Öffnen Sie dieurl in einem Browser oder senden Sie sie per E-Mail oder Chat an die Person.
Die Person sieht den Einwilligungsbildschirm, wählt Didit Test Bank aus, meldet sich mit einem der Testkunden an und wählt die Konten aus, die sie freigeben möchte.
Auf der Sandbox-Seite finden Sie die Testkunden und welche Daten jeder von ihnen liefert.
Wie Sie die Person anschließend wieder auf Ihre Website zurückleiten, erfahren Sie unter Zurück zu Ihrer Website.
Ohne redirect_url landet die Person auf der Ergebnisseite von Didit, und Sie erfahren das Ergebnis über den Webhook oder über einen Abruf.
Schritt 4: Webhooks empfangen und bestätigen
Abonnieren Sie in der Konsole ein Webhook-Ziel für die Ereignissebank.*, wie bei jedem Webhook.
Sobald die Person den Vorgang abgeschlossen hat, wird bank.link.completed mit der link_id und der connection_id gesendet. Danach folgt bank.connection.created, sobald die erste Synchronisierung die Konten gespeichert hat.
Vertrauen Sie niemals einer Link-ID, die Ihnen ein Browser übermittelt.
Rufen Sie den Link selbst ab:
status ist completed oder ein endgültiger Status (cancelled, expired, failed). Ein failed-Link enthält einen error.code; bei einem cancelled-Link steht error: null.
Schritt 5: Konten, Salden und Transaktionen abrufen
next_page_token, solange noch weitere Daten abgerufen werden können.
Siehe Konten, Salden und Transaktionen.
Schritt 6: dem Änderungsfeed folgen
Der Änderungsfeed liefert nur die Änderungen seit Ihrem letzten Abruf. Ihr erster Abruf ohne Cursor ist der vollständige Snapshot: jede Transaktion der Verbindung, jeweils alsadded mit reset: true.
Eine erste Seite kann has_more: true mit einem next_page_token enthalten, aber noch keinen next_cursor.
Solange has_more den Wert true hat, rufen Sie weitere Seiten mit page_token ab. Den next_cursor der letzten Seite (der mit has_more: false) speichern Sie für den nächsten Abruf:
reset: true bedeutet, dass die Antwort ein vollständiger Snapshot ist: Ersetzen Sie Ihre Kopie durch diese Antwort, statt sie zu ergänzen.
bank.data.updated zeigt Ihnen an, wann eine Synchronisierung etwas Neues gespeichert hat.
Schritt 7: jetzt synchronisieren
Eine laufende Verbindung synchronisiert sich automatisch. Um die Bank jetzt abzufragen, fordern Sie eine Synchronisation an:sync.live_syncs_left_today und sync.budgets an der Verbindung zeigen, wie viele noch übrig sind und wann sie zurückgesetzt werden. Ein Aufruf über dem Limit antwortet mit 429 refresh_limit_reached und dem Zeitpunkt des Zurücksetzens.
Siehe Bankdaten bei Bedarf aktualisieren.
Schritt 8: Zugriff beenden und löschen
Das Beenden des Zugriffs und das Löschen sind zwei verschiedene Aufrufe.id, status, status_reason, created_at und erasure zurück.
Siehe Daten, Einwilligung und Löschung.
Nächste Schritte
- Verbindungen: einmaliger und laufender Zugriff, Einwilligung und Erneuerung.
- Bank-Webhooks
- Preise
- API-Referenz