Einführung und API-Zugriff

Willkommen zur Dokumentation von Beenia Application API Interface! Diese Dokumentation bietet einen detaillierten Überblick über die öffentliche API, mit der Sie sich in unsere Plattform integrieren und auf verschiedene Funktionen und Daten zugreifen können.

‍

Einführung

Die Beenia Application API wurde entwickelt, um es externen Entwicklern zu ermöglichen, mit unserer Anwendung zu kommunizieren und ihre Funktionen in ihren eigenen Anwendungen oder Diensten zu nutzen. Die öffentliche API bietet die Möglichkeit, Daten auf unserer Plattform abzurufen und zu aktualisieren, Transaktionen abzuwickeln und andere Vorgänge durchzuführen, die für Ihre Bedürfnisse unerlässlich sind.

Es ist wichtig zu beachten, dass unsere Anwendung auch interne REST-Schnittstellen enthält, die für interne Zwecke bestimmt sind und nicht öffentlich zugänglich sind. Diese internen Schnittstellen sind für die interne Entwicklung und das Anwendungsmanagement vorgesehen und nicht Teil dieser Dokumentation.

Zugriff auf die API

Um Zugriff auf die öffentliche API der Beenia-Anwendung zu erhalten, müssen Sie einen API-Schlüssel verwenden. Mit diesem Schlüssel können Sie sich authentifizieren und sicherstellen, dass Sie Anfragen an unsere API stellen können. Der API-Schlüssel muss im Header jeder REST-Anfrage unter dem Parameter X-KEY enthalten sein. Dieser Schlüssel ist für Ihr Konto eindeutig und wird verwendet, um Ihre Identität und Autorisierung zur Nutzung der API zu überprüfen. Informationen zum Erhalt Ihres API-Schlüssels und weitere Authentifizierungsdetails finden Sie unter https://www.beenia.com/article/zapier-integration-for-beenia.

‍

API

Sobald Sie Ihren API-Schlüssel erhalten haben, können Sie unsere API verwenden, um verschiedene Operationen durchzuführen. Die API-Dokumentation enthält Informationen zu verfügbaren Endpunkten und Parametern.

Authentifizierung/Test

Dieser REST-Endpunkt ermöglicht die Authentifizierung mit der Integration, indem der API-Schlüssel im X-KEY-Anforderungsheader bereitgestellt wird.

Anfrage:

• Methode: BEKOMMEN
• Pfad: /external/v0/zapier/webhooks/
• Kopfzeile:

• X-TASTE: API-Schlüssel für die Authentifizierung.

Antwort:

Nach erfolgreicher Authentifizierung erfolgt die Antwort im JSON-Format:

{

„connectionName“: „Name des Mandanten wird getestet“

}

Beschreibung der Attribute:

• Name der Verbindung: Der Name des Mieters, mit dem wir die Verbindung hergestellt haben.

‍

‍