The digital passes are becoming incresingly common use around the world to substitute paper passes, reach wider audiences and speed deliveries up. The API described in this documentation allows you to create a single template to deliver multiple passes and bind information with any data server to write on them specific data. Once your end-users have accepted the passes you sent, you can update each single pass or all the passes delivered simultaneously according to your needs.

The two main digital wallets in the market are supported: Apple Wallet and Google Pay. You can use the same single template to reach both platforms and their respective protocols.

This API allows you to manipulate in many ways your wallet campaigns: you can create a template and, later on, retrive it, modify it or delete it; you order the creation of the passes by building their delivery URLs and matching their variable fields with the external source data origin of your preference. The delivery endpoint checks the platform of your end-users with your directives to know what kind of pass it will deliver. Apple Wallet format file .pkpass can be also read by several Android Apps; this platform has support for Attido Passwallet Push update service if you order Android to get that format instead of Google Pay.

The server sets up the proper endpoints to accomplish with Apple Wallet Push update protocol. You only have to order the updates and the platform will do the rest backstage. In Google Pay the passes are updated in the cloud and the devices synchronize to the last information stored.

This API follows the RESTful principles, therefore the endpoints have noun names, they have to be called with the proper HTTP verb (GET, POST, PUT or DELETE) and the larger information is sent via payload. The transactional results are sent in XML while the objects can be defined in XML or JSON. The endpoints where you interact to the server directly are signed, while those called by devices are not, due to Apple's protocol path structure.

To start a Wallet campaign you need to be registered in Messangi platform. If you are not registered, please conntact with our support team. When registered you can check your company name using Get organization name, used inside passes' metadata. The campaign requires the following resources and steps:

1. Create a Wallet template: call the Create Wallet Template endpoint and send on payload the Wallet Template object in JSON format.
2. Upload passes images: you have to provide from 2 up to 6 images to fill in the template. These images will be used in all the passes delivered from the server. Call the Store image file for Wallet to upload one by one.
3. Querying: If you want to check the information you stored in the Wallet template use Get Wallet Template. Also, if you want to check the images you uploaded to support that template, use Get Wallet image file. And if you want to get a list of all the templates you created use Get Wallet Templates list.
4. If you want to add custom data inside the passes, you must set the matches between your source data origin fields and the template fields using Set template-to-data attribute matches. Your source data origin server has to provide an endpoint to query the custom data everytime.
5. To create and enable the final passes in the server just call Get Wallet URL list with the recipients list (phone number list only or email address list only) and you will get in response a JSON object, mapping the URL for each one of them. With that URLs your end-users will get the passes with the art of the template and the information of the template matched with your data origin according to your commands in the previous step.
6. The URLs you get in the previous step are shortened URLs to the enpoint Wallet passes Delivery. You must not call it directly, the valid calls are just made by the previous endpoint.
7. In order to track your campaign broadcasts you can use the Register Wallet Campaign. There you can store important metadata of each broadcast you made. To retrieve the previous information use Get Wallet broadcast.
8. When you need to make changes to the template itself use Update Wallet template and send in the payload the Wallet Template object in JSON format.
9. Apple requires from Wallet developers set up several endpoints to manage the protocol to register and unregister devices and passes in order to enable Apple Push Notification Service. All that work is already made inside this server with the endpoints in Register Device for Wallet updates, Register Device for PassWallet updates, Send New Pass to Wallet apps, Get changed passes list, Remove Wallet Registration and Logging errors from device to server. You only have to provide the information of your template fields, images and recipients and the server will manage all the protocol process.
10. To send dynamic updates to your end-users' passes, use Send massive push updates for passes when changes has been made in template. But if you just want to reach a single end-user use Send single pass push update instead.
11. Once you consider your campaign is over and you don't want your customers to get new passes from that campaign, use Delete Wallet Template to delete all the information in the server.

Given a client identificator code, returns the Organization name used as parameter in some endpoints in this API

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/organization/{clientId}/{timeStamp}/{signature}

A String text with the Organization name related with the clientId

Stores a Wallet template in the server using a JSON object data.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/{templateName}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

POST https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

A json object with proper structure of a Wallet template object. You can build this object using our java beans available herepassbookbeans.rar

	{
	"transitType":null,
	"thumbnail":null,
        "thumbnailFixed":null,
	"footer":null,
        "footerFixed":null,
	"templateName":Demo Passes for customers",
	"organization":"Company Name",
	"iBeacons":[{"major":100,"minor":10,"fixed":"f","text":"This is a beacon","status":"","uuid":"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"}],
	"logo":"31345fa5b31a87c0590eb50d77add0975649139a",
        "logoFixed":"f",
	"passTypeId":"pass.com.messangi.passbook",
	"templateSHA1":"90c382c79b7534a58c87f27e97ef1ce541831197",
	"strip":null,
        "stripFixed":null,
	"background":null,
        "backgroundFixed":null,
	"lastUpdated":"30-08-2015 12:11:25",
	"expirationDate":"2017-02-07T12:10:00-05:00",
	"description":"Test wallet",
	"serial":"LYWcpB3nzMX1Cpmx6OFcfK1GlZNtm_FnnOeFY7CONvlZuBpcL5BWHoa3xKAd7bxqKBhD1OM2Hh45TGnEb6MFi6pIu58wp-cIzzeAx3BQboQ*",
	"relevantDate":"2017-01-04T12:10:00-05:00",
	"barcodeContent":"https://www.google.com/",
	"barcodeLabel":"Google Official Web Page",
	"backgroundColor":"#2255ff",
	"labelColor":"#ab45b0",
	"foreColor":"#38aab1",
	"descriptionFixed":"f",
	"logoTextFixed":"f",
	"relevantDateFixed":"f",
	"expirationDateFixed":"f",
	"barcodeContentFixed":"f",
	"barcodeLabelFixed":"f",
	"icon":"31345fa5b31a87c0590eb50d77add0975649139a",
        "iconFixed":"f",
	"maximumDistance":100,
	"barcodeType":"QR",
	"locations":[{"latitude":37.43900253544606,"longitude":-122.1458918105788,"status":"","label":"Boulevard Arturo Uslar Pietri, Caracas, Miranda, Venezuela"}],
	"logoText":"testqa",
	"passbookType":"storecard",
	"fields":[{"fixed":"f","status":"","label":"Label Auxiliary","place":"AUXILIARY","value":"Content Auxiliary"},{"fixed":"f","status":"","label":"Label Back Side","place":"BACK","value":"Content Back Side"},{"fixed":"f","status":"","label":"Label Header","place":"HEADER","value":"Content Header"},{"fixed":"f","status":"","label":"Label Primary","place":"PRIMARY","value":"Ogangi"},{"fixed":"f","status":"","label":"Label Secondary","place":"SECONDARY","value":"Content Secondary"}]
	}

	<TransactionResult>
		<successful>true</successful>
		<message>
			Template: Successful operation - Fields: Successful operation - Locations: Successful operation - iBeacons: Successful operation 
		</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Sends a specific image of a Wallet template stored on server. It's useful to verify if an image is available and check the image art itself.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/image/{templateName}/{filename}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

GET https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/image/{templateNameEncoded}/{filename}/{clientId}/{timeStamp}/{signature}

The requested PNG image file.

Creates a new file for a support Wallet image. It stores the image in three different sizes automatically, to comply Apple Wallet standard (non-retina, retina and retina HD).

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/image/{templateName}/{filename}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

POST https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/image/{templateNameEncoded}/{filename}/{clientId}/{timeStamp}/{signature}

The Input Stream of Multipart data from the original file.

Returns HTTP Status 200 if the file is successfully stored, HTTP Status 500 otherwise

Lists the main information about all templates related to a specific organization.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/{filter}/{initialRow}/{finalRow}/{clientId}/{timeStamp}/{signature}

A list with data of the tenmplates: template name, Wallet type, number of images uploaded, barcode type, number of locations associated and number of iBeacons associated. All other properties are ignored and presented as null

Example response XML:

	<PassbookTemplateList>
		<records>16</records>
		<listPassbook>
			<organization xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<templateName>Demo pass for customers</templateName>
			<passbookType>storecard</passbookType>
			<transitType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<logo>31345fa5b31a87c0590eb50d77add0975649139a</logo>
			<icon>31345fa5b31a87c0590eb50d77add0975649139a</icon>
			<strip xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<background xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<footer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<thumbnail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<backgroundColor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<labelColor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<foreColor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<descriptionFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<serial>
				LYWcpB3nzMX1Cpmx6OFcfK1GlZNtm_FnnOeFY7CONvlZuBpcL5BWHoa3xKAd7bxqKBhD1OM2Hh45TGnEb6MFi6pIu58wp-cIzzeAx3BQboQ*
			</serial>
			<logoText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<logoTextFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<relevantDate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<relevantDateFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<barcodeType>QR</barcodeType>
			<barcodeContent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<barcodeContentFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<barcodeLabel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<barcodeLabelFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<maximumDistance>0</maximumDistance>
			<expirationDate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<expirationDateFixed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<templateSHA1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<passTypeId xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<lastUpdated xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
			<fields/>
			<locations>
				<locations>
					<label/>
					<latitude>0.0</latitude>
					<longitude>0.0</longitude>
				<status/>
				</locations>
			</locations>
			<iBeacons>
				<iBeacons>
					<fixed/>
					<major>0</major>
					<minor>0</minor>
					<status/>
					<text/>
					<uuid/>
				</iBeacons>
			</iBeacons>
		</listPassbook>	
		<listPassbook>
			(...)	
		</listPassbook>
	</PassbookTemplateList>

Deletes a Wallet template from the server and all its descendent data.

DELETE https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/{templateName}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

DELETE https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Returns a JSON object with a whole template data with its dependecies (fields, locations and iBeacons)

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/{templateName}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

GET https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

The JSON Object of the requested Template

	{
	"transitType":null,
	"thumbnail":null,
	"footer":null,
	"templateName":Demo Passes for customers",
	"organization":"Company Name",
	"iBeacons":[{"major":100,"minor":10,"fixed":"f","text":"testqa","status":"","uuid":"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"}],
	"logo":"31345fa5b31a87c0590eb50d77add0975649139a",
	"passTypeId":"pass.com.messangi.passbook",
	"templateSHA1":"90c382c79b7534a58c87f27e97ef1ce541831197",
	"strip":null,
	"background":null,
	"lastUpdated":"30-09-2016 12:11:25",
	"expirationDate":"2017-02-07T12:10:00-05:00",
	"description":"Test wallet",
	"serial":"LYWcpB3nzMX1Cpmx6OFcfK1GlZNtm_FnnOeFY7CONvlZuBpcL5BWHoa3xKAd7bxqKBhD1OM2Hh45TGnEb6MFi6pIu58wp-cIzzeAx3BQboQ*",
	"relevantDate":"2017-01-04T12:10:00-05:00",
	"barcodeContent":"https://www.ogangi.com/",
	"barcodeLabel":"Ogangi Official Web Page",
	"backgroundColor":"#2255ff",
	"labelColor":"#ab45b0",
	"foreColor":"#38fab1",
	"descriptionFixed":"f",
	"logoTextFixed":"f",
	"relevantDateFixed":"f",
	"expirationDateFixed":"f",
	"barcodeContentFixed":"f",
	"barcodeLabelFixed":"f",
	"icon":"31345fa5b31a87c0590eb50d77add0975649139a",
	"maximumDistance":100,
	"barcodeType":"QR",
	"locations":[{"latitude":37.43900253544606,"longitude":-122.1458918105788,"status":"","label":"Boulevard Arturo Uslar Pietri, Caracas, Miranda, Venezuela"}],
	"logoText":"testqa",
	"passbookType":"storecard",
	"fields":[{"fixed":"f","status":"","label":"Label Auxiliary","place":"AUXILIARY","value":"Content Auxiliary"},{"fixed":"f","status":"","label":"Label Back Side","place":"BACK","value":"Content Back Side"},{"fixed":"f","status":"","label":"Label Header","place":"HEADER","value":"Content Header"},{"fixed":"f","status":"","label":"Label Primary","place":"PRIMARY","value":"Ogangi"},{"fixed":"f","status":"","label":"Label Secondary","place":"SECONDARY","value":"Content Secondary"}]
	}

Edits a Wallet template data from a JSON object data.

PUT https://api.messangi.com/messangi-staging/rest/message/Passbook/templates/{templateName}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

PUT https://api.messangi.com/messangi-staging/rest/message/Passbook64/templates/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

A json object with proper structure of a Wallet template object. You can build this object using our java beans available here<INSERTE AQUI ZIP DE BEANS>

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Returns the Wallet URL list in a JSON object for passes distribution

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/urlList/{templateName}/{listId}/{sourceDataOrigin}/{timezone}/{campaignName}/{clientId}/{timeStamp}/{signature}?androidPkpass={true|false}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

POST https://api.messangi.com/messangi-staging/rest/message/Passbook64/urlList/{templateNameEncoded}/{listId}/{sourceDataOrigin}/{timezone}/{campaignName}/{clientId}/{timeStamp}/{signature}?androidPkpass={true|false}

A JSON array with all the target recipients. For example if you deliver by SMS:

	[
		"15417543010",
		"15572681217",
		"15671638489",
		(...)
	]

If you deliver by email:

	[
		"rosesmith@gmail.com",
		"johndoe@gmail.com",
		"danielroberts@outlook.com",
		"bmontgomery@yahoo.com",
		(...)
	]

A JSON object with recipients as keys and urls as values. If you deliver by SMS:

	{
		"15417543010": "http://your_shortener.com/r/60c71492-e",
		"15572681217": "http://your_shortener.com/r/986a118b-c",
		"15671638489": "http://your_shortener.com/r/9bb40219-9",
		(...)
	}

If you deliver by email:

	{
		"rosesmith@gmail.com": "http://your_shortener.com/r/3ba4ee97-2",
		"johndoe@gmail.com": "http://your_shortener.com/r/e2c83f97-4",
		"danielroberts@outlook.com": "http://your_shortener.com/r/d576d2ac-e",
		"bmontgomery@yahoo.com": "http://your_shortener.com/r/08b5e4e0-1"
		(...)
	}

Stores in the server the mathes (mapping) between the Wallet template and the source data origin list attributes.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/matches/{templateName}/{sourceDataOrigin}/{listId}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

POST https://api.messangi.com/messangi-staging/rest/message/Passbook64/matches/{templateNameEncoded}/{sourceDataOrigin}/{listId}/{clientId}/{timeStamp}/{signature}

A JSON object with template variable attributes as keys and soure data origin list attributes as values. Every template sector has a specific notation, use only those that applies to your template:

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

IMPORTANT: On sourceDataOrigin parameters, you can provide an endpoint URL to which a raw GET request will be made for each recipient (the call will be made to the sourceDataOrigin + recipient URL), its response must be a JSON object with the mapped field names as keys and field contents as values. e.g:

For recipient id 16123457890

Call to https://www.example.com/rest/internal/yourservice/16123457890 or

https://www.example.com/rest/internal/yourservice?id=16123457890

Response:

	{
	"Name":"John Doe", 
	"Department": "Sales", 
	"Points", 100, 
	"Code": "1B487-4GT"
	}

Stores in the server a record of your broadcast, with some useful metadata. It's a record only function, it does not fire a broadcast itself.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/broadcast/{beginDate}/{serial}/{sourceDataOrigin}/{listType}/{listId}/{pushMode}/{pushText}/{attachment}/{recipientsNumber}/{changedField}/{clientId}/{timeStamp}/{signature}

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Stores in the server a record of your broadcast, with some useful metadata. It's a record only function, it does not fire a broadcast itself.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook64/broadcast/{beginDate}/{serial}/{sourceDataOrigin}/{listType}/{listId}/{pushMode}/{pushText}/{attachment}/{recipientsNumber}/{changedField}/{clientId}/{timeStamp}/{signature}

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Stores in the server several broadcasts at once, with some useful metadata. It's a record only function, it does not fire broadcasts itself.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/broadcast//{beginDate}/{serial}/{pushMode}/{pushText}/{attachment}/{clientId}/{timeStamp}/{signature}

A json object with proper structure of a array de broadcast object.

	[
	  {
	    "id": 0,
	    "listType": 2,
	    "listIndex": "https://messangi.com/messangi_mmc",
	    "listId": 281,
	    "pushMode": false,
	    "attachment": false,
	    "recipientsNumber": 2,
	    "changedField": "fields.SECONDARY.Label%20Secondary"
	  }
	]

	<transactionResultList>
	    <message>Operation results</message>
	    <successful>true</successful>
	    <results>
		<successful>true</successful>
		<message>Successful operation</message>
	    </results>
	</transactionResultList>

Returns a list with all the Wallet broadcasts registered using the registration endpoint.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/broadcast/{templateName}/{clientId}/{timeStamp}/{signature}

A JSON array with all the broadcast that were registered before. For example:

	[
		{"id":133,"beginDate":"11-09-52_27-01-2016","serial":"od283XOROduIF0o5r1-2S0e_NZInA124pySdvsTiDl0ERdmwEtHc-iD_D57AhYA3","listType":2,"listIndex":"{base_url}","listId":281,"pushMode":false,"pushText":"null","attachment":false,"recipientsNumber":3, "changedField":null},
		{"id":281,"beginDate":"04-40-42_29-02-2016","serial":"od283XOROduIF0o5r1-2S0e_NZInA124pySdvsTiDl0ERdmwEtHc-iD_D57AhYA3","listType":1,"listIndex":"http://test.me.syniverse.com/messangi_mmc","listId":4433,"pushMode":false,"pushText":"null","attachment":false,"recipientsNumber":3, "changedField":null},
		(...)
 
	]

Sends the .pkpass file for Apple devices (iPhone and iPod) or gives the Google Pay button for Android devices and iPads. This endpoint is called with the URL created in Get Wallet URL list

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/delivery/{organization}?{templateID=...}&{authenticationToken=...}&{androidPkpass=...}&{clientId=...}

The response of this endpoint will depend on the platform and kind of the end-user device:

• Delivers .pkpass file of the Apple Wallet pass if the end-user device is an iPhone or an iPod, or if androidPkpass parameter is true.

• Delivers Save to Google Pay Button to deliver Google Pay pass if the end-user device has Android OS or is an iPad (Apple iPad hasn't Apple Wallet available).

Fires massive updates in the end-users devices that have already downloaded the passes. The server sends APNS to Apple Devices and updates the Google Pay passes in the cloud for Android Devices.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/update/sendPush/{templateName}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

GET https://api.messangi.com/messangi-staging/rest/message/Passbook64/update/sendPush/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Fires APNS to every Apple device that registered a specific pass and updates the pass in Google Pay cloud.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/update/sendPushPass/{templateName}/{recipient}/{listId}/{sourceDataOrigin}/{clientId}/{timeStamp}/{signature}

If you want to use special characters in template name just encode it using base64 and call this endpoint instead of the previous one:

GET https://api.messangi.com/messangi-staging/rest/message/Passbook64/update/sendPushPass/{templateNameEncoded}/{recipient}/{listId}/{sourceDataOrigin}/{clientId}/{timeStamp}/{signature}

	<TransactionResult>
		<successful>true</successful>
		<message>Successful operation</message>
		<extraInfo></extraInfo>
	</TransactionResult>

Follows the Apple Wallet URL protocol to set up the proper end point that is called by Apple devices when a pass is added to the wallet app. Once a pass is registered, the app registers the device on the server.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/devices/{deviceLibraryId}/registrations/{passTypeId}/{serial}

The Authorization header is supplied; its value is the word ApplePass, followed by a space, followed by the pass’s authentication token as asigned by the server.

The POST payload is a JSON dictionary containing a single key and value:

pushToken: The push token that the server can use to send push notifications to this device.

• If the serial number is already registered for this device, returns HTTP status 200.

• If registration succeeds, returns HTTP status 201.

• If the request is not authorized, returns HTTP status 401.

• Otherwise, returns the appropriate standard HTTP status.

Follows the Attido PassWallet URL protocol to set up the proper end point that is called by Android devices when a pass is added to the Passwallet app. This Android app reads and renders properly the .pkpass file format of Apple Wallet passes. Once a pass is registered, the app registers the device on the server.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/devices/{deviceLibraryId}/registrations_attido/{passTypeId}/{serial}

The Authorization header is supplied; its value is the word “Attido Pass”, followed by a space, followed by the pass's authentication token as specified in the pass.

The POST payload is a JSON dictionary, containing two key and value pairs:

1. pushToken: The pushtoken that the server can use to send push notifications to this device.
2. pushServiceUrl: The URL of Attido’s web service for posting update notifications to devices.

• If the serial number is already registered for this device, return HTTP status 200.

• If registration succeeds, return HTTP status 201.

• If the request is not authorized, return HTTP status 401.

• Otherwise, return the appropriate standard HTTP status.

The endpoint that is called by the devices to ask for the new .pkpass file when updating process is activated. Follows the Apple Wallet URL protocol to set up the proper endpoint that is called by Apple devices when a new version of a pass is requested.

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/passes/{passTypeId}/{serial}

The Authorization header is supplied; its value is the word ApplePass, followed by a space, followed by the pass's authentication token as specified in the pass.

• If request is authorized, returns HTTP status 200 with a payload of the pass data.

• If the request is not authorized, returns HTTP status 401.

• Otherwise, returns the appropriate standard HTTP status.

Sends to devices the list of all the passes that have changed on the same server sionce

GET https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/devices/{deviceLibraryId}/registrations/{passTypeId}?{passesUpdatedSince=...}

If the passesUpdatedSince parameter is present, returns only the passes that have been updated since the time indicated by tag. Otherwise, returns all passes.

Exmaple:

	{"lastUpdated":"30-06-2016 14:25:02", "serialNumbers":["Gizk4PDHPN64TjIOjuDRczu99ngU_ZBb71Cfp43qHqqrQBcIdLpU9JeU7FQUnaLJTc_RGF-N3UsZokZ91F_fQpuDmVfy4fqqjPqDagXVIFQ*", "kuofjNEweWz9oFdbhtyAKPc7W9ldCIAiDnlsow7FbbLxc71TMdgBnXGZreQMy1gK", (...)]}

Deletes from the server the registration of a Wallet pass.

DELETE https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/devices/{deviceLibraryId}/registrations/{passTypeId}/{serial}

The Authorization header is supplied; its value is the word ApplePass, followed by a space, followed by the pass's authentication token as specified in the pass.

• If disassociation succeeds, returns HTTP status 200.

• If the request is not authorized, returns HTTP status 401.

• Otherwise, returns the appropriate standard HTTP status

When some error occurs in Wallet app, the device calls this endpoint to notify the server the description of the malfunction.

POST https://api.messangi.com/messangi-staging/rest/message/Passbook/update/v1/log

The POST payload is a JSON dictionary, containing a single key and value:

logs (string): An array of log messages as strings.

Returns HTTP status 200.

Stores a Wallet template with yours respective images in the server using a JSON object data.

POST https://api.messangi.com/messangi-staging/rest/message/wallet/v1/templates/{templateNameEncoded}/{clientId}/{timeStamp}/{signature}

Input Stream of Multipart data with the image files and a Wallet template JSON object. You can build this object using our java beans available herepassbookbeans.rar

	{
	"transitType": null,
	"thumbnail": null,
	"thumbnailFixed": null,
	"footer": null,
	"footerFixed": null,
	"templateName": "Demo Passes for customers ",
	"organization": "Company Name",
	"iBeacons": [{
		"major": 100,
		"minor": 10,
		"fixed": "f",
		"text": "This is a beacon",
		"status": "",
		"uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"
	}],
	"logo": "31345fa5b31a87c0590eb50d77add0975649139a",
	"logoFixed": "f",
	"passTypeId": "pass.com.messangi.passbook",
	"templateSHA1": "90c382c79b7534a58c87f27e97ef1ce541831197",
	"strip": null,
	"stripFixed": null,
	"background": null,
	"backgroundFixed": null,
	"lastUpdated": "30-08-2015 12:11:25",
	"expirationDate": "2017-02-07T12:10:00-05:00",
	"description": "Test wallet",
	"serial": "LYWcpB3nzMX1Cpmx6OFcfK1GlZNtm_FnnOeFY7CONvlZuBpcL5BWHoa3xKAd7bxqKBhD1OM2Hh45TGnEb6MFi6pIu58wp-cIzzeAx3BQboQ*",
	"relevantDate": "2017-01-04T12:10:00-05:00",
	"barcodeContent": "https://www.google.com/",
	"barcodeLabel": "Google Official Web Page",
	"backgroundColor": "#2255ff",
	"labelColor": "#ab45b0",
	"foreColor": "#38aab1",
	"descriptionFixed": "f",
	"logoTextFixed": "f",
	"relevantDateFixed": "f",
	"expirationDateFixed": "f",
	"barcodeContentFixed": "f",
	"barcodeLabelFixed": "f",
	"icon": "31345fa5b31a87c0590eb50d77add0975649139a",
	"iconFixed": "f",
	"maximumDistance": 100,
	"barcodeType": "QR",
	"locations": [{
		"latitude": 37.43900253544606,
		"longitude": -122.1458918105788,
		"status": "",
		"label": "Boulevard Arturo Uslar Pietri, Caracas, Miranda, Venezuela"
	}],
	"logoText": "testqa",
	"passbookType": "storecard",
	"fields": [{
		"fixed": "f",
		"status": "",
		"label": "Label Auxiliary",
		"place": "AUXILIARY",
		"value": "Content Auxiliary"
	}, {
		"fixed": "f",
		"status": "",
		"label": "Label Back Side",
		"place": "BACK",
		"value": "Content Back Side"
	}, {
		"fixed": "f",
		"status": "",
		"label": "Label Header",
		"place": "HEADER",
		"value": "Content Header"
	}, {
		"fixed": "f",
		"status": "",
		"label": "Label Primary",
		"place": "PRIMARY",
		"value": "Ogangi"
	}, {
		"fixed": "f",
		"status": "",
		"label": "Label Secondary",
		"place": "SECONDARY",
		"value": "Content Secondary"
	}]
}

Returns HTTP Status 201 and the Wallet template if is successfully stored, HTTP Status 400 if any information in the payload is missing, HTTP Status 401 if your not aunthenticate correctly in the service, HTTP Status 500 otherwise.

Edits a Wallet template data or images from a JSON object data.

PUT https://api.messangi.com/messangi-staging/rest/message/wallet/v1/templates/{serial}/{clientId}/{timeStamp}/{signature}

A mandatory json object with proper structure of a Wallet template object and an optional Input Stream of Multipart data with image files. You can build the json object using our java beans available herepassbookbeans.rar

Returns HTTP Status 200 and the Wallet template if is successfully updated, HTTP Status 400 if any information in the payload is missing, HTTP Status 401 if your not aunthenticate correctly in the service, HTTP Status 500 otherwise.

Translation of the Wallet template to Google Pay is done automatically and can be activated with the following flag of the Wallet JSON object:

{
	...
 
        ,"androidPayCompatible":true
        ...
}

Google Pay cards have two image elements of their own: the Hero and Main image, the hero image is shown where the strip would be on an apple Wallet pass, and is taken by default from different images depending on Wallet template type, according to this mapping.

You can specify Hero and Main images by making use of special fields, marked as GOOGLEPAY on the place field attribute. Upload your Hero or Main images as hero or main on the multipart request, and add the fields to the Wallet JSON object with the following labels:

{
...
"fields": [
...
          {
           "fixed": "f",
           "label": "heroImage",
           "place": "GOOGLEPAY",
           "value": "<Image-SHA>",
           "status": ""
          },
          {
           "fixed": "v",
           "label": "mainImage",
           "place": "GOOGLEPAY",
           "value": "Var",
           "status": ""
          },
...
]
...
}

The Hero image is always fixed, the Main image is entirely optional and you can set it as any other variable field.

Translation of boarding passes requires additional fields: Departure Time, Origin and Destination airport information. Set them on the Wallet object with the following labels:

{
...
"fields": [
...
          {
           "fixed": "f",
           "label": "boardingDepartureDateTime",
           "place": "GOOGLEPAY",
           "value": "2018-12-01T16:46:00-05:00",
           "status": ""
          },
 
          {
           "fixed": "f",
           "label": "boardingOrigin",
           "place": "GOOGLEPAY",
           "value": "John F Kennedy Intl",
           "status": ""
          },
          {
           "fixed": "f",
           "label": "boardingOriginCode",
           "place": "GOOGLEPAY",
           "value": "JFK",
           "status": ""
          },
          {
           "fixed": "f",
           "label": "boardingDestination",
           "place": "GOOGLEPAY",
           "value": "Frankfurt",
           "status": ""
          },
          {
           "fixed": "f",
           "label": "boardingDestinationCode",
           "place": "GOOGLEPAY",
           "value": "FRA",
           "status": ""
          },
...
]
...
}

Departure Time is set with ISO8601 format as other dates with timezone. Origin and Destination airport codes must be valid IATA Codes. If you don't specify these fields, the GPay boarding pass will still be generated using dummy values.