Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WayApp offers knowhow and a comprehensive REST API to bolster your mobile marketing plans. Wow your customers with innovative campaigns that add value and bring them closer to your brand.

In order to use the WayApp Wallet REST API you need to be setup as Customer. Contact WayApp at your earliest convenience in order to get your credentials. All Customer calls need special credentials.

In your setup as a Customer you will have the option to use your own credentials and certificates for the Apple Wallet Development Program and Google's Save to Android Pay Development Program. You need to contact them directly to get your own credentials. Or you can use credentials provided to you by WayApp.

Examples of the Apple program credentials are passTypeIdentifier and teamIdentifier, both linked to the Apple issued wallet item certificate.

WayApp also offers a web interface that does all the API calls for you. Please check our web based solution to make sure your business needs are not covered there.

The following are the main elements of the customer setup:

  • Apple and Google development program credentials;
  • Callback URLs to your own systems;
  • Account creation keys. Currently there are two types of accounts that you can setup, admin and restricted;
  • Your WayApp assigned private and public keys that you will need for signing each and everyone of the REST API calls;

In addition to these main elements you can also provide convenience configuration elements that will used throughout all the API calls as defaults (if none provided in optional fields). Example of these convenience fields include logo, background, label and text colors for wallet items.

The Wallet REST API allows management of the full lifecycle of a wallet item (Passes in Apple's jargon).

Wallet items are saved and updated on the smartphone's Wallet app, no app download is necessary:




The API groups the lifecycle of the wallet item in the following functionality:

  1. Creating a new wallet item;

  2. Updating an existing wallet item. Updates include its elimination or expiration;

  3. Check-in of a wallet item. Whenever the wallet item is used in any way by the user;

  4. Intelligence and analytics of wallet item use;

In order to use the API you need to be registered as a Customer (please contact us at contact@wayapp.com). Customers setup various independent Accounts. Each Account can setup its own wallet item Templates, and for each Template issue and manage Cards.

These are example of this relationship:

  • Retailer is setup as a Customer. Retailer sets up all its store locations as Accounts. Each store configures Templates based on the store's location, running promotions, etc.

  • Bank is setup as a Customer. Bank sets each of its branches and ATM locations as an Account. ATM offers users the option of  digital transaction ticket delivered as a wallet item (no need for paper);

  • Software vendor integrates Wallet API functionality into their own product (Customer). Each of their customers (users of the software product) is setup as an Account.