In diesem Artikel erläutern wir einige API-spezifischen Begriffe, Abkürzungen und Akronyme, die im Rahmen unserer Produkte/Dienstleistungen vorkommen. Setzen Sie sich mit api@gocardless.com in Verbindung, wenn Sie einen Begriff vermissen oder weitere Fragen haben.
A
Zugriffstoken – Ein einzigartiges Kennzeichnen für Händler, die Zugriff zur API anfragen. Ein Händler kann im Dashboard einen Zugriffstoken erstellen. Bei einer Anfrage können wir den zur Verfügung gestellten Token dann mit dem von uns gespeicherten Token abgleichen, um den anfragenden Händler zu authentifizieren und zu identifizieren.
API – Brücke zwischen zwei Systemen, die normalerweise nicht zusammenarbeiten würden, z. B. Systeme, die keine gemeinsam Sprache haben, in der sie miteinander kommunizieren können.
App – Darstellung einer Partnerintegration.
App-Gebühr – Eine Gebühr, die ein Partner zusätzlich zu den Gebühren verlangen kann, die GoCardless für eine Transaktion in Rechnung stellt.
C
Kunden-ID – Zur Authentifizierung und Identifizierung einer Partner-App während des OAuth-Flows.
Client-Bibliothek – Ein Code, den Entwickler zu ihren Entwicklungsprojekten hinzuzufügen können.Sie bietet Code-Teile für grundlegende Aktionen, sodass eine Anwendung mit der API interagieren kann und spart einem Entwickler damit Zeit und Mühe.
Client-Kennwort – Zur Authentifizierung und Identifizierung einer Partner-App während des OAuth-Flows.
Benutzerdefinierte Zahlungsseite – Eine Zahlungsseite, die vom Integrator selbst gehostet wird. Integratoren, die benutzerdefinierte Zahlungsseiten verwenden, nutzen üblicherweise keine Umleitung.
E
Endpunkt – Ein Endpunkt ist einfach ein Ende eines Kommunikationskanals mit der API, so würden Sie beispielsweise den Endpunkt /subscriptions verwenden, um Anfragen zu Daueraufträgen zu stellen.
H
HTTP-Header – HTTP-Header sind Namen- oder Wertpaare, die in der Anfrage und der Antwort auf Nachrichten-Header für das Hypertext Transfer Protocol (HTTP) angezeigt werden. Beim Stellen einer HTTP-Anfraget an die API ist ein Header mit Authorization, GoCardless-Version, Accept und Content-Type erforderlich.
I
Idempotency Key – Ein Header, der jeder Anfrage an die API hinzugefügt werden kann, um zu verhindern, dass dieselbe Anfrage mehrfach gestellt wird. Alle Anfragen zur Erstellung einer Ressource mit einem Key, der bereits verwendet wurde, schlagen fehl und geben einen 409
idempotent_creation_conflict Fehler
aus.
Integration – Ein System, das die API verwendet, um Ressourcen zu erstellen und zu managen, z. B. Websites, Customer Relation Management Software, Buchhaltungssoftware, Content-Managementsystem usw.
J
Javascript-Flow – Wird von Händlern mit benutzerdefinierten Zahlungsseiten verwendet, um Bankdaten von Kunden sicher auf unserem Server zu speichern.
JSON – Ein visuell lesbares, einfaches Datenaustauschformat. In diesem Format werden die meisten Informationen über die API versendet und abgerufen.
M
Metadaten – Daten, die Informationen über andere Daten beschreiben und geben. Mit Metadaten können benutzerdefinierte Daten zu einem Kunden, einer Zahlung, einem Dauerauftrag und bestimmten Aktionen wie dem Wiederholen einer Zahlung hinzugefügt werden.
O
OAuth – Mit OAuth kann ein Partner mit GoCardless-Konten anderer Benutzer arbeiten. Sobald Sie von einem Kunden genehmigt wurden, können Sie die GoCardless-API in seinem Namen verwenden und seine Webhooks empfangen.
P
Paginierungsliste – Immer, wenn Sie eine Anfrage nach einer Liste von Ressourcen von der API stellen, gibt es eine Obergrenze der Zahl der ausgegebenen Ressourcen. Wenn die Ergebnisse die Obergrenze überschreiten, gibt die API eine Paginierungsliste aus, mit der Sie weitere Anfragen stellen können, um alle Ergebnisse zu erhalten.
Post-Onboarding-URL – Während des OAuth-Flows können Sie prüfen, ob ein Händler bereits verifiziert wurde. Wenn der Händler sich noch verifizieren lassen muss, können Sie ihn durch den Post-Onboarding-Flow schicken, um sein Konto zu verifizieren. Nach dem Onboarding-Flow wird der Händler zur Post-Onboarding-URL weitergeleitet, die auf Ihrer App eingestellt werden kann.
Zur Veröffentlichung geeignete Zugriffstoken – Während des Javascript-Flows wird der zur Veröffentlichung geeignete Zugriffstoken in ein Zahlungsformular eingebettet. Nach dem Einsenden des Formulars wird dann mithilfe des zur Veröffentlichung geeigneten Zugriffstokens ein Token des Kunden-Bankkontos bezogen, um die neu erstellte ID des Bankkontos abzurufen, die auf unseren Servern gehostet wird.
R
Umleitung – Mit Umleitungen können Sie Lastschriftmandate mithilfe von GoCardless gehosteten Zahlungsseiten für Ihre Kunden einrichten.
Umleitungs-URL – Die URL, zu der ein Kunde geleitet wird, nachdem er seine Zahlungsdaten über die Umleitung eingegeben hat.
Anfrage-ID – Jede Anfrage an unsere API kann durch ihre einmalige Anfrage-ID identifiziert werden.
Eingeschränkter Endpunkt – Ein Endpunkt, der nur für Händler/Partner mit aktivierten, benutzerdefinierten Zahlungsseiten zugänglich ist.
Umsatzabhängig – Ein prozentualer Anteil, den Partner von den GoCardless-Transaktionsgebühren abziehen können.
S
Szenarien-Simulator – Besondere Kundennamen, die in einer Sandbox-Umgebung verwendet werden können, um aufeinanderfolgende Events sofort auszulösen.
Sitzungs-Token – Eine zufällige ID, die zur Verfügung gestellt werden muss, wenn die Umleitung erstellt wird, und noch einmal, wenn die Umleitung abgeschlossen ist. Damit können Integratoren gewährleisten, dass der Benutzer, der ursprünglich zu den GoCardless-Zahlungsseiten weitergeleitet wurde, mit dem Benutzer identisch ist, der die Aktion abgeschlossen hat.
T
Test-Webhook – Ein Webhook, der manuell mithilfe von Testdaten in der Sandbox-Umgebung gesendet werden kann.
W
Webhook – Ein Webhook ist eine Anfrage, die GoCardless an den Server eines Händlers sendet, um ihn über ein Event zu informieren. Damit kann der Händler Echtzeit-Benachrichtigungen von GoCardless erhalten, wenn etwas in seinem Konto passiert, sodass er mit automatischen Maßnahmen darauf reagieren kann.
Webhook-Passwort – Eine einmalige ID, die zur Identifizierung und Authentifizierung Ihres Webhook-Endpunkts verwendet wird. Das Webhook-Passwort wird zur Unterzeichnung von Webhooks verwendet, um die Echtzeit des gesendeten Webhooks zu gewährleisten.