GetPassTemplates #
The GetPassTemplates API will fetch the list of the Pass Templates present under the account identified by the api-key. This API fetches the data in a paginated way. Users can provide the page number and data needed per page required and API will send the required data.
| Params/Variables | Format | Description |
|---|---|---|
| action | Mandatory, Alphabetic (a-zA-Z) | This is the name of the function you want to execute with the API. |
| x-api-key | Mandatory, Alphanumeric (a-zA-Z0-9), Case-Sensitive. This is set in the request header param. |
This is a random key that is assigned to an account and can be used for authorization. You can find and regenerate this key on the ‘API Settings’ page. |
| page-number | Optional, Numeric | Users can provide the page number using this parameter and the user will receive data from this page number. |
| items-per-page | Optional, Numeric (Default is 100) | Users can provide the count of data required per page and the API will send that amount of data in response. |
Response Success Example:
Response Failure Example:
Required Parameters:
action, x-api-key, pass-template-id, zip code
Request:
Request Example:
Response Success Example:
Response Failure Example:
GeneratePassById #
The generate pass by id API will generate a unique installation link based on the unique ‘pass-id’. If you try to call this API with an invalid ‘pass-id’ or a ‘pass-id’ that is not associated with the pass that you are trying to generate, you will receive an error message. To call this API again successfully, you will need to use a valid ‘pass-id’. The required parameters are action, api-key, pass-id, and pass-template-id.
Request:
Request Example:
Request Example:
Response Success Example:
Response Failure Example:
DeletePassData #
#
The delete pass data API is used to remove data for a Pass that has already been installed on a device. Using this API will only delete the pass data associated with the ‘pass-id’ from our system. This does not remove or uninstall the Pass from the device. If you receive a failure message, the Pass data has not been deleted. The required params are action, api-key, pass-id, and pass-template-id .
#
Request:
Request Example:
Response Success Example:
Response Failure Example:
GetPassIds #
The GetPassIds API will fetch a list of passes, generated for a given Pass Template under the user account identified by the api-key. This API fetches the data in a paginated way. Users can provide the page number and data needed per page required and API will send the required data.
#
#
#
| Params/Variables | Format | Description |
|---|---|---|
| action | Mandatory, Alphabetic (a-zA-Z) | This is the name of the function you want to execute with the API. |
| x-api-key | Mandatory, Alphanumeric (a-zA-Z0-9), Case-Sensitive. This is set in the request header param. |
This is a random key that is assigned to an account and can be used for authorization. You can find and regenerate this key on the ‘API Settings’ page. |
| pass-template-id | Mandatory, Alphanumeric (a-zA-Z0-9), Case-Sensitive | This is the unique Pass Template ID used to reference a particular Pass Template. |
| page-number | Optional, Numeric | Users can provide the page number using this parameter and the user will receive data from this page number. |
| items-per-page | Optional, Numeric (Default is 100) | Users can provide the count of data required per page and the API will send that amount of data in response. |