Please note that free support for this subject area is limited. If you require more extensive support, we are happy to offer you paid services.
What is the API of edoobox
With the edoobox API, edoobox customers have direct access to all data. This facilitates the connection to 3rd party applications and an individual output on their website. All edoobox resources are included via JSON Web Token and of course all resources have the POST, PUT, GET and DELETE options.
Authorization groups
With API V2, you have the option of equipping the APIs with customized rights. For example, if you need all invoice information for your accounting tool, you only allow the required information in a rights group created especially for the API.
The 4 main authorization groups "Super administrator rights", "Administrator and manager rights", "Only limited manager rights" and the "Manager (limited)" are intended to limit the access of administrators in the system. These can also be used for API V2 access, since as an admin you automatically receive access to the API V2 with your login data.
Please note: Additional authorization groups
However, edoobox suggests that if you want to introduce restrictions on the API V2, you should create a new authorization group to prevent an admin from losing a right relevant to the administrator. This could lead to the app not working as intended or too many rights being assigned to the API.
Access to API V2
You can access the Postman from the edoobox API V2 via the following link: https://api.docs.edoobox.com/
Tip: Postman (developer)
Postman provides the ability to create, test, simulate and debug API requests, making API development easier for everyone.
Info: Base URL
Please use your edoobox admin username and password for login, and "https://app2.edoobox.com/v2" as the Base URL.
Access with Postman
If you are working with Postman, create an environment with all necessary variables. After creating the environment, select it in Postman and execute the /auth-Request. A more detailed explanation of these two steps can be found in the guide: edoobox API: Getting Started Possible Environment Variables for accessing the POST Auth API interface:
|
base_url |
|
|
api_key |
key_330498self9450ss93464ls345 |
|
api_sec |
sec_e1b3d4bdbf273450405ab342 |
|
edid |
|
|
token |
|
|
expire |
|
|
yubikey |
|
Currently, environments cannot be published in the documentation.
Access without Postman
With curl a typical request would look as follows. Queries in other programming languages can be generated.
curl --location -g --request POST 'https://app2.edoobox.com/v2/auth' --header 'grant-type: password' --head
er 'Content-Type: application/json' --data-raw '{
"key": "<Ihr key-Schlüssel>",
"secret":"<Ihr sec-Schlüssel>",
"expire":"2030-01-01T01:00:00+02:00"
}'
The code can be executed in an independent Docker container and should return HTTP status 200 with the desired JSON response.
Info: API ERROR Codes
A complete list of all error codes can be found at the following link: edoobox API V2
Info: Invalid API
Verify that the API keys are valid for the sandbox or live environment and are activated.
Info: Username and Password Authentication
API V2 allows username and password authentication only with an HTTPOnly cookie. In the request, the property reply as the value cookie must be set. Subsequently, all further requests must include the headers cookie with the cookie _edlogin=<cookie-token>, edid: <edid> and the grant-type: access_token must be included.
If a token is desired instead of an HTTPOnly cookie, authentication can be performed using the authentication keys.
API V1 Access
You can find "API V1 Access Management" in the "Main Navigation" under "Settings".
To gain access to the API V1, you must create API keys in your edoobox account. To do this, go to "Settings," which you can find in the "Main Navigation." Under "API Access Management," you can click the "Add Key" button.
Info: API V1
API V1 is no longer being developed and should therefore no longer be used. Existing interfaces will continue to work.
API V1 is also still used for the WordPress plugin. No new key needs to be created here.
Related Guides
Keywords for this guide
API § API Keys § Postman § ERROR Codes