Pass URL Keys

A Pass can be generated from an API URL. Pass URL Keys “unlock” a Pass record so that it may accept certain dynamic variables through a URL string. This IS NOT required if you are passing variables through the API or uploading them via CSV. This is required if you are using a third party email system and want to add variables into the Pass via a “Mail Merge” technology.

Create Pass URL Keys

1. In order to use Pass URL Keys, select the “# Keys” link for a pass template in the Pass Templates page.

Pass URL Keys

2. Once you are redirected to the Pass URL Keys page, press the “Import URL Keys” button to begin the import process.

Pass URL Keys

3. Once you are redirected to the Import Keys page, press the “Upload CSV/TSV” button to upload your list.

Pass URL Keys

In your CSV/TSV file, there should be two columns:

  • Custom Pass ID: A random key that cannot be guessed. It should be unique per issued pass.
  • Customer Reference: A reference, such as an email address, phone number, or customer ID, used to refer to a pass data record.

Both columns are required for the import and are used to validate the dynamic URL when requesting a pass. Also note the instructions for uploading a CSV/TSV file.

4. Map the expected URL Keys to the corresponding columns of your CSV/TSV file.

Pass URL Keys

5. There are two settings:

  • Skip the first row when importing the URL param file: If the first row of you uploaded file is made up of column headers (in this case, the custom pass ID and customer reference), check this setting.
  • Add validation when importing the URL param file: If you want to add validation for issuing the pass, check this setting. Once checked, the custom pass ID must be correctly passed in the URL in order to generate the pass.

url parameters

Once you are done with the settings, press the “Import Pass Data” button to complete the import.

6. You will be redirected back to the Pass URL Keys page, where you will see your imported custom pass IDs and customer references at the bottom. If you checked the validation setting from the import process, then it will display “On”.

Pass URL Keys

7. To test a Pass URL, an example URL is provided within the platform. A valid dynamic URL must always consist of the custom pass ID, customer reference, and a unique passkey in order to generate the pass.

In the URL, replace the {CustomIdentifier} with the custom pass ID and the {CustomerReference} with the customer reference (this includes removing the curly braces {}). Then enter the URL in a web browser.

Example URL:

https://d2c.skycore.com/passes/pass?passkey=c43fa3a8c50ee2cdd559dde651ebe34352dd0f62&custompassid=57460b5c39e3f&customerref=16170000000

url key wallet example

In the Pass Templates page, if you click the “# Records” in the Pass Data column, you will see that a new pass data has been added.

wallet data records

view mobile wallet data

Pass URL Keys FAQs

How can I pass dynamic data to the pass?

During mail merge, additional optional parameters can be added to the dynamic URL. The fields must be set to dynamic in the pass template builder. The parameters correspond to the fields in the pass template builder. Below is the list of parameters and corresponding fields:

  • bval: Barcode value
  • btxt: Barcode text
  • hl1, hv1: Header label, Header value
  • pl1, pv1, pl2, pv2: Primary Label 1, Primary Value1, Primary Label 2, Primary Value 2
  • sl1, sv1, sl2, sv2, sl3, sv3, sl4, sv4: Secondary Label 1, Secondary Value 1, Secondary Label 2, Secondary Value 2, etc.
  • al1, av1, al2, av2. al3, av3, al4, av4: Auxiliary Label 1,¬†Auxiliary Value 1, Auxiliary Label 2, Auxiliary Value 2, etc.
  • bl1, bv1, bl2, bv2, bl3, bv3, bl4, bv4: Back Label 1, Back Value 1, Back Label 2, Back Value 2, etc.

The format for the dynamic URL is

https://d2c.skycore.com/passes/pass?passkey={passKey}&custompassid={customPassID}&customerref={customerReference}&bval={barcodeValue}&btxt={barcodeText}&hl1={headerLabel1}&hv1={headerValue1}…

Example URL:

https://d2c.skycore.com/passes/pass?passkey=03895fafd443324e9aecba38c2ca872cbcae745c&custompassid=57460b65dc0f4&customerref=16170000001&av1=Becky+Heart&av2=3-14

example pass with dynamic data

In this example, “&av1=Becky+Heart&av2=3-14” is appended to the URL. The “Auxiliary Value 1” field of the pass, which corresponds to the name, is passed with the value “Becky Heart”. The “Auxiliary Value 2” field of the pass, which corresponds to the row & seat number, is passed with the value “3-14”.

Here’s the pass data record.

pass data record

How does the validation setting work?

If you checked the validation setting during the import process, then the custom pass ID must be correctly passed in the dynamic URL in order to generate the pass. For example:

https://d2c.skycore.com/passes/pass?passkey=c43fa3a8c50ee2cdd559dde651ebe34352dd0f62&custompassid=57460b6c2a43a&customerref=16170000002

The custom pass ID in this example is 57460b6c2a43a. If the value passed in ‘custompassid’ was something else or empty, then the pass will not be generated unless it was generated previously.

If you did not check the validation setting during the import process, then the pass can be generated regardless of the value passed in ‘custompassid’.

in Mobile Wallet