TapCheck Validation API (1.0.0)
Download OpenAPI specification:Download
Welcome to the TapCheck Validation API documentation. These pages describe the endpoints available within TapCheck to validate tickets. An api key is required to access this api. Please contact tapcheck@ximedes.com or your Public Transport Operator to get yours!
TapCheck Issuing API
If you are looking for the TapCheck Issuing API description please visit: https://tapcheck.io/developers.html
Bearer Auth
Authentication and authorization is based on a pre-shared API key. The API key is to be included in every API call in the Authorization header using the Bearer method.
Example:
curl --location --request POST 'https://issuing.tapcheck.io/v1/tickets/create' --header 'Authorization: Bearer z6QkOERZsWbQC4QcwIdexgEWZHJP4VNF8CfQogaZmXV=' --header 'Content-Type: application/json' --data-raw '{ "salesChannelId": "1", "ticketLanguage": "NL", "productCode": "0001", "validityStart":"2020-12-03" }'
Note: z6QkOERZsWbQC4QcwIdexgEWZHJP4VNF8CfQogaZmXV= is not a real API key, just shown for illustration purposes.
Access to specific endpoints is dependent on the agreements made with public transport operator you are connecting to. So not every endpoint might be available to you even though the endpoint is described in this documentation.
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | bearer |
Inspect barcode
Inspects whether a barcode is valid.
Authorizations:
Request Body schema: application/json
| barcode required | string <byte> (Barcode) Bytes contained in a barcode, encoded as base64. |
required | object (InspectDevice) |
Responses
Request samples
- Payload
{- "barcode": "string",
- "device": {
- "deviceId": "string",
- "modality": "BUS",
- "lastStop": {
- "id": "24123",
- "name": "Station Haarlem"
}, - "nextStop": {
- "id": "24123",
- "name": "Station Haarlem"
}
}
}Response samples
- 200
{- "valid": true,
- "ticketId": "KJj43nejhbTxhr897287"
}