Edara API Walk Through
What is Edara API
Edara API allows users to integrate Edara ERP with external systems. Through this API, businesses can seamlessly automate data transfer and synchronization between Edara ERP and various platforms such as e-commerce websites, CRMs, and third-party tools. This provides a flexible solution for connecting and managing business operations efficiently.
Using the Edara API, users can:
- Access data related to purchasing, invoicing, stock, and more.
- Create and manage orders, products, customers, and suppliers.
- Retrieve real-time information to streamline business processes.
The API offers a comprehensive set of endpoints, making it easy for developers to implement custom integrations for their specific needs.
How to Create an API User
To get started with the Edara API, follow these steps to create an API user:
- Access your Edara account.
- Navigate to Integrations > Rest API.
- Click Add New User.
- Provide the necessary permissions to ensure the API user has access to the appropriate data and functionalities.
Once the API user is created, you can generate an access token that will be used to authenticate and interact with the Edara API.
How to Use the Edara API
After creating an API user and obtaining the API credentials, follow these steps to interact with Edara ERP using the API:
1. Authentication
Edara API uses Bearer Token authentication. To authenticate API requests, include the token in the header like this:
Authorization: Bearer {your_token}
You will receive the token when you create the API user. The token allows secure communication between your application and Edara ERP.
2. Base URL and Endpoints
The base URL for the API is:
https://api.edara.io/
Each API call is made to a specific endpoint. The API version is included in the URL, and the endpoint indicates the resource you are interacting with. For example:
https://api.edara.io/v2.0/Taxes
3. Query Parameters
Many endpoints allow you to specify query parameters to filter or paginate the data. Here are some common parameters:
offset
: Specifies the starting point of the data selection (e.g., the 10th record).limit
: Limits the number of retrieved records.
Example request with query parameters:
https://api.edara.io/v2.0/Taxes?offset=10&limit=50
4. API Example - Fetching Taxes
To retrieve a list of taxes from Edara, make a GET request to the following endpoint:
GET https://api.edara.io/v2.0/Taxes
Example response:
{
"status_code": 200,
"result": [
{
"id": 1,
"name": "VAT",
"rate": 14.0,
"active": true
},
{
"id": 2,
"name": "Service Tax",
"rate": 5.0,
"active": true
}
],
"total_count": 2
}
This basic guide provides the necessary steps for getting started with Edara API, including authentication and making a simple GET request. Refer to the attached API documentation for more details on other available endpoints and parameters.