Skip to main content

Getting started

Using a ReconHub API​

Integrating one of the ReconHub APIs into your application is easy.

Please refer to the following sections on authentication and endpoints to familiarize yourself with the basics. After this, you can start calling the API of your choice.

The APIs are available via https://api.reconhub.cloud and APIs are organized around REST. Our APIs have predictable resource-oriented URLs, accept form-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication, and verbs.

APIs​

  • Sales API
    This API provides functionality to upload, list and get sales transactions.

Authentication​

To use a ReconHub API a ReconHub user with the role API must be created in the ReconHub User Administration for the desired tenant. Like normal users, an API user can be assigned to organizational units and will only have access to the assigned objects.

Authorization​

ReconHub APIs currently support HTTP Basic authentication (see RFC7617).

Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and username:password as a base64-encoded string.

Access to a specific tenant​

If the user has access to multiple tenants, the customerId or tenantId must be specified in the query parameters. Otherwise, the request will fail with an error 401 (Unauthorized). To get the customerId or tenantId, it is currently necessary to contact our support team.

Note: This must only provided if the user has access to multiple tenants.

Example​

// User has access to a single tenant
GET https://api.reconhub.cloud/sales/v1/
Authorization: Basic ZGVtbzpwQDU1dzByZA==

//  User has access to multiple tenants
GET https://api.reconhub.cloud/sales/v1/?tenantId=4c1410b5-8a82-4a2d-99fd-8a0ae927b1b5
Authorization: Basic ZGVtbzpwQDU1dzByZA==

// User has access to multiple customers
GET https://api.reconhub.cloud/sales/v1/?customerId=d05e9f6c-b41a-4de6-955f-e5fcbbea6116
Authorization: Basic ZGVtbzpwQDU1dzByZA==

// User has access to multiple customers and tenants
GET https://api.reconhub.cloud/sales/v1/?customerId=d05e9f6c-b41a-4de6-955f-e5fcbbea6116&tenantId=4c1410b5-8a82-4a2d-99fd-8a0ae927b1b5
Authorization: Basic ZGVtbzpwQDU1dzByZA=

Security​

All our APIs can only be accessed through the secure https protocol.

End-to-end safety on the transport level is guaranteed by the HTTPS-requirement, no need to encrypt the data itself again. We only support TLS 1.2 (or higher). Connection is not possible when using a lower version.

HTTPS mitigates packet sniffing and timing & replay attacks. Thanks to HTTPS, data exchanged between ReconHub and the client is protected and guaranteed to be authentic. HTTPS implements hashed signatures, nonces and other tried and tested cryptographic safeties.