Developer Documentation (API)
- Authentication
- PHP Package
- V2 Endpoints
- Pass Templates
- Get a list of templates
- Describe the structure of a pass template
- Create a new template
- Update a template
- Patch a template
- Publish changes of a template
- Get information about fields of a pass-template only
- Schedule a Push Notification
- List scheduled notifications of a template
- Delete a scheduled Push Notification
- Copy a Pass Template
- Delete a Pass Template
- Create an iFrame Integration for a Template
- Create an URL Integration for a Template
- Passes
- REST Hooks
- Validating passes
- Deprecated endpoints
V2 Endpoints
With the introduction of our template API we started to standardize the API responses and use a common response format.
Old endpoints are still supported and maintained unless they are marked as deprecated.
All API endpoints that have a structure like https://veski.leikbreytir.is/api/doc … will return a JSON object like this.
Successful - data will contain the actual data that has been requested:
{
"success": true,
"description": "Request succeeded",
"errors": [],
"data": [],
"statusCode": 200
}
Failure:
{
"success": false,
"description": "Invalid data.",
"errors": [
{
"property": "name",
"message": "The property name is required"
},
{
"property": "type",
"message": "The property type is required"
},
{
"property": "expiration.expirationDate",
"message": "The specified format was wrong. Please use Y-m-d H:i e.g. 2025-01-01 15:30"
}
],
"data": [],
"statusCode": 400
}