Introduction and API access
Welcome to the documentation of Beenia Application API Interface! This documentation provides a detailed overview of the public API that allows you to integrate with our platform and access various features and data.
Welcome to the documentation of Beenia Application API Interface! This documentation provides a detailed overview of the public API that allows you to integrate with our platform and access various features and data.
Introduction
The Beenia Application API is designed to enable external developers to communicate with our application and leverage its functionalities in their own applications or services. The public API offers the ability to retrieve and update data in our platform, process transactions, and perform other operations that are essential for your needs.
It is important to note that our application also includes internal REST interfaces meant for internal purposes and are not publicly accessible. These internal interfaces are intended for internal development and application management and are not part of this documentation.
Accessing the API
To gain access to the public API of the Beenia Application, you need to use an API key. This key allows you to authenticate yourself and ensure that you can make requests to our API. The API key must be included in the header of every REST request under the parameter X-KEY. This key is unique to your account and is used to verify your identity and authorization to use the API. Information on how to obtain your API key and further authentication details can be found at https://www.beenia.com/article/zapier-integration-for-beenia.
API
Once you have obtained your API key, you can start using our API to perform various operations. The API documentation includes information about available endpoints and parameters.
Authentication / Test
This REST endpoint allows authentication with the integration by providing the API key in the X-KEY request header.
Request:
- Method: GET
- Path: /external/v0/zapier/webhooks/
- Header:
- X-KEY: API key for authentication.
Response:
Upon successful authentication, the response will be in JSON format:
{
"connectionName": "Testing name of tenant"
}
Description of attributes:
- connectionName: The name of the tenant with which we established the connection.