Integration API #
This API enables integration with other software systems. It provides the functionallity of data import into both Dubee and Brix customs solution software. Future versions will include basic type of data query functionality from systems.
Versioning #
When an API changes in a way that is backwards-incompatible, we increase the version number of the API.
Errors #
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response.
Endpoints #
https://dubee.app/api/integration/uploadDataUpload data Request #
POSTAuthorisation #
This endpoint is user-restricted - it requires an Basic Authorization header containing username and password.
Request headers #
| Name | Description |
|---|---|
|
TraderId
required |
Specifies the ID you will receive from our system that helps us identify you as our client. |
|
IntegrationType
required |
Specifies the type of the integration. Currently supported only code For example: GENERAL
|
|
File2Process
optional |
Specifies the file name for the import. If you will be using this parameter, make sure you don't repeat the file name twice because the same file wont be processed 2 or more times. This could be used for debug purposes with us if something does not work |
|
ContentType
required |
You should use following :application/xml; charset=UTF-8 |
|
Authorization
required |
An Basic Username/Password Authorization is required For example: Basicbb7fed3fe10dd235a2ccda3d50fb |
Response #
| Scenario | HTTP status | Code |
|---|---|---|
|
Unauthorized |
401 (Unauthorized) |
INVALID_TRADERID TRADERID_NOT_ALLOWED |
|
Invalid header |
406 (Not Acceptable) |
MISSING_HEADERS INVALID_FILE_TYPE INVALID_MODULE_ID INVALID_IMPORT_TYPE
|