Opening a WebSockets connection
Obtain your API key and publish your first message.
Step 1. Get your API keys
Use the Dojo developer portal to receive your API key (apiKey). Reach out to your Partnership Development Manager (PDM) if you do not have access to the developer portal. This is required to receive and send messages to the API.
Step 2. Open a WebSocket connection to the EPOS Data API
To start integrating with the EPOS Data API, you can use our test endpoint. This endpoint allows you to simulate payments on the card machine, making it easier for you to develop and test your integration:
wss://eu.ws.dojo.tech/epos
Ensure you're using a WebSocket client that enables you to set the required headers:
| Header Name | Description |
|---|---|
| Authorization | Basic authorization is used to authenticate your requests to the API using your API key as the value, for example: Basic $apiKey. |
reseller-id (optional) | Identifies the reseller who sells software on behalf of the EPOS company. This value will be unique and provided by Dojo to each reseller. |
software-house-id | Identifies the EPOS company whose software is generating the request. This value shouldn't be configurable as it will remain the same for all customers using particular EPOS software. This value will be provided by Dojo. |
All of these values will be provided by Dojo. If you're unsure about any of them, reach out to your PDM.
Step 3. Confirm the WebSocket connection
Ensure that you were able to successfully establish the WebSocket connection. Look out for any errors and reach out to your PDM if you require further assistance.
Next steps
You're now ready to start building your EPOS integration!