Getting Started
Logos Connect Public API is a public API to interact with Wash and Fuel Points. Each request operates
within the context of an instance (your site/organization), identified by an
instanceId in the URL.
Authentication
Every request must include an API key as a bearer token:
Authorization: Bearer {API_KEY}
API keys are issued by Logos Payment Solutions and are scoped to specific roles (e.g. Fuel, Wash, CreditNote) and a specific instance. A key will only work for the operations and instance it was granted access to. Contact Logos Payment Solutions to request a key for your integration.
Versioning
The API is versioned via the URL path, e.g. /api/v1/instances/{instanceId}/....
Request headers
Authorize/terminate requests also require:
| Header | Required | Description |
|---|---|---|
X-Operation-Id | Yes | A unique ID (UUID) you generate to identify this operation across the whole system for traceability. |
X-Customer-Id | No | The ID of the end user. Not required, but recommended for traceability. |
Custom status codes
When authorizing or terminating fuel/wash operations, the response includes both an HTTP status code and a more specific custom status code in the response body, so consumers can distinguish e.g. which conflict occurred (machine in the wrong state vs. unknown site, etc.):
| Code | Id |
|---|---|
| Success | 200 |
| BadRequest | 400 |
| Unauthorized | 401 |
| Forbidden | 403 |
| SystemError | 10000 |
| UnknownSiteId | 10011 |
| UnknownCarWash | 10012 |
| ProductNotFound | 10021 |
| ProductNotValid | 10501 |
| UnableToStartWash | 10502 |
| UnableToStopWash | 10503 |
| CarWashWrongState | 10604 |
| CarWashUnavailable | 10606 |
| UnknownPumpId | 10701 |
| PumpNotReady | 10702 |
| PumpFailedToRelease | 10703 |
| UnableToStartPump | 10704 |
| UnableToStopPump | 10705 |
| DispenserWrongState | 10706 |
Events
Operations are asynchronous: an authorize/terminate call only acknowledges that the request was received, while the actual outcome (and further state changes) arrive as webhook events. See the Events guide.