/passkit-golang-members-quickstart

Quickstart to create, distribute, analyse and manage your Digital Membership Cards for Apple Wallet and Google Pay

Primary LanguageGo

passkit-golang-members-quickstart

The PassKit Golang SDK makes it quick and easy to create and install your branded membership passes for Apple Wallet and Google Pay.

This repository has following structure with each purpose.

  • certs folder is a place to store your credential files.
  • examples folder contains SDK methods you can use to create membership cards and engage with members.

Table of Content

Installation

Install passkit-io-go with:

go get -u github.com/PassKit/passkit-golang-sdk

Then, import SDK with:

import(
    "github.com/PassKit/passkit-golang-sdk/io/members"
    "github.com/PassKit/passkit-golang-sdk/io"
)

Prerequisites

  1. Create a PassKit account. Sign up for free HERE.

  2. Generate & Download your SDK credentials by clicking the 'GENERATE NEW SDK CREDENTIALS' button from the Developer Tools page in the portal.

Quickstart

By completing this Quickstart, you will be able to issue a membership card for a new member.

  1. Ensure your followed the steps in prerequisites.

  2. Install PassKit Golang SDK with:

    go get -u github.com/PassKit/passkit-golang-sdk

  3. Place your SDK credential files (certificate.pem, key.pem and ca-chain.pem) in the certs folder in this repoo. The SDK uses these .pem files to authenticate against the PassKit server.

  4. Now we need to decrypt your key.pem. At your project root directory, run cd ./certs openssl ec -in key.pem -out key.pem. Your key.pem file should look like below. ScreenShot If you do not see Proc-Type: 4,ENCEYPTED on line 2, you have successfully decrypted key.pem.

  5. Replace YOUR_EMAIL_ADDRESS@EMAIL.COM in main.go with your email address in order to receive the welcome email with card url which your member will also receive.

  6. Go back to root directory with cd ../... Then run go run main.go to create a sample program (with default template & tier) and issue a membership card against that.

Examples

Issue A Membership Card.

Follow the steps of the Quickstart to create a sample membership card and experience it in your Mobile Wallet.

Engage With Your Members

EngageWithMembers() contains multiple methods you can use to engage with your members. For example, you can update contents of digital membership card or send a push notification.

GUI Tool

GUI tool can be accessed from your PassKit account.

Documentation

Check Other Passes

  • Coupons (coming soon)
  • Flight Ticket (coming soon)

Getting Help

License

Distributed under MIT License. Details available on license file.