Skip to content

Commit 5555164

Browse files
canderson1538canderson1538
committed
Added coupons, membership and flights methods to quickstart
1 parent 42b910c commit 5555164

27 files changed

+932
-2
lines changed

‎README.md

+76-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,76 @@
1-
# passkit-python-quickstart
2-
Python Quickstart to create, distribute, analyse and manage your Digital Coupons / Membership / Boarding Passes for Apple Wallet and Google Pay
1+
PassKit Python Quickstart
2+
=======================
3+
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Version](https://badge.fury.io/py/passkit-python-grpc-sdk.svg)](https://pypi.org/project/passkit-python-grpc-sdk/)
6+
7+
### Overview
8+
9+
This quickstart aims to help get Python developers up and running with the PassKit SDK as quickly as possible.
10+
11+
### Prerequisites
12+
13+
You will need the following:
14+
15+
- A PassKit account (signup for free at https://app.passkit.com)
16+
- Your PassKit SDK Credentials (available from the https://app.passkit.com/app/account/developer-tools)
17+
- Python 3.7 or above from https://www.oracle.com/java/technologies/downloads/ (https://docs.oracle.com/en/java/javase/18/install/overview-jdk-installation.html - guide on how to download)
18+
- Gradle Build Tool from https://gradle.org/install/ with guide on how to install
19+
- Apple wallet certificate id (for flights only, https://app.passkit.com/app/account/certificates)
20+
![ScreenShot](images/certificate.png)
21+
22+
### Configuration
23+
24+
1. Download or clone this quickstart repository, create a folder `certs` in the resources folder of the repository and add the following three PassKit credential files:
25+
- certificate.pem
26+
- ca-chain.pem
27+
- key.pem
28+
29+
You can disregard the key-java.pem credentials file as it is not compatible with Python.
30+
2. Use `pip install passkit-python-grpc-sdk` to download the latest sdk from python.
31+
32+
### Membership Cards
33+
In the membership folder the methods there are:
34+
- create-program.py - takes a new program name and creates a new program
35+
- create-tier.py - takes the programId of the program just created in the above program, creates a new template (based of default template), creates a tier, and links this tier to the program
36+
- enrol-member.py - takes programId and tierId created by the above methods, and memberDetails, creates a new member record, and sends a welcome email to deliver membership card url
37+
- update-member.py - takes memberId and memberDetails, and updates existing member record
38+
- check-in-member.py - takes memberId and location details and checks in the selected member
39+
- check-out-member.py - takes memberId and location details and checks out the selected member
40+
- earn-points.py - takes a programId of an existing program and memberId of existing member to add points to chosen member
41+
- burn-points.py - takes a programId of an existing program and memberId of existing member to use points from a chosen member
42+
- delete-member.py - takes programId, tierId, memberId and memberDetails, deletes an existing member record
43+
44+
### Coupons
45+
In the coupons folder the methods are:
46+
- create-campaign.py - takes a new campaign name and creates a new campaign
47+
- create-offer.py - takes a campaignId of the campaign you just created and creates a new template (based of default template), creates an offer, and links this offer to the campaign
48+
- create-coupon.py - takes campaignId and offerId created by the above methods, and couponDetails, creates a new coupon record, and sends a welcome email to deliver coupon card url
49+
- list-coupons.py - takes campaignId and returns list of coupon records under that campaign
50+
- update-coupon.py - takes a campaignId of an existing campaign and couponId of existing coupon to update that coupon
51+
- redeem-coupon.py - takes a campaignId of an existing campaign and couponId of existing coupon to redeem that coupon
52+
- void-coupon.py - takes the couponId, offerId and campaignId to void an existing coupon
53+
54+
### Boarding Passes
55+
#### Issue A Boarding Pass.
56+
In the flights folder the methods are:
57+
- create-template.py - creates the pass template for flights and boarding passes
58+
- create-carrier.py - takes a new carrier code and creates a new carrier
59+
- create-airport.py - takes a new airport code and creates a new airport.
60+
- create-flight.py - takes templateId , from previous method, to use as base template and uses a carrier code, created from previous method, and creates a new flight
61+
- create-flight-designator.py - creates flight designator using flight code
62+
- create-boarding-pass.py - takes templateId, from previous method, and customer details creates a new boarding pass, and sends a welcome email to deliver boarding pass url
63+
- delete-flight.py - takes an existing flight number as well as other details and deletes the flight associated with it
64+
- delete-flight-designator.py - takes an existing flight designation and deletes the flight designator associated with it
65+
- delete-airports.py - takes an existing airport code and deletes the airport associated with it
66+
- delete-carrier.py - takes an existing carrier code and deletes the carrier associated with it
67+
68+
69+
## Documentation
70+
* [PassKit Membership Official Documentation](https://docs.passkit.io/protocols/member)
71+
* [PassKit Coupons Official Documentation](https://docs.passkit.io/protocols/coupon)
72+
* [PassKit Boarding Passes Official Documentation](https://docs.passkit.io/protocols/boarding)
73+
* [PassKit Events Official Documentation](https://docs.passkit.io/protocols/event-tickets/)
74+
75+
76+

‎coupons/create-campaign.py

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import grpc
2+
import io.single_use_coupons.campaign_pb2 as campaign_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
5+
6+
def create_campaign():
7+
# Create channel credentials
8+
credentials = grpc.ssl_channel_credentials(
9+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
10+
11+
# Create a secure channel
12+
channel = grpc.secure_channel(
13+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
14+
15+
# Create a stub
16+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
17+
18+
# Create campaign
19+
campaign = campaign_pb2.CouponCampaign()
20+
campaign.Name = "Quickstart Campaign"
21+
campaign.Status = [1, 4]
22+
response = couponsStub.createCouponCampaign(campaign)
23+
print(response)
24+
25+
26+
create_campaign()

‎coupons/create-coupon.py

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import grpc
2+
import io.single_use_coupons.coupon_pb2 as coupon_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
import io.common.personal_pb2 as personal_pb2
5+
6+
7+
def create_coupon():
8+
# Create channel credentials
9+
credentials = grpc.ssl_channel_credentials(
10+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
11+
12+
# Create a secure channel
13+
channel = grpc.secure_channel(
14+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
15+
16+
# Create a stub
17+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
18+
19+
# Create coupon
20+
coupon = coupon_pb2.Coupon()
21+
coupon.OfferId = "" # Get offerId from createOffer call or dashboard
22+
coupon.CampaignId = "" # Get campaignId from createCampaign call or dashboard
23+
coupon.Sku = ""
24+
25+
person = personal_pb2.Person()
26+
person.DisplayName = "Loyal Larry"
27+
person.EmailAddress = ""
28+
29+
coupon.Person = person
30+
response = couponsStub.createCoupon(coupon)
31+
print(response)
32+
33+
34+
create_coupon()

‎coupons/create-offer.py

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
import grpc
2+
import io.single_use_coupons.offer_pb2 as offer_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
import io.core.a_rpc_templates_pb2_grpc as a_rpc_templates_pb2_grpc
5+
import io.common.template_pb2 as template_pb2
6+
import google.protobuf.timestamp_pb2 as timestamp_pb2
7+
import datetime
8+
9+
10+
def create_offer():
11+
# Create channel credentials
12+
credentials = grpc.ssl_channel_credentials(
13+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
14+
15+
# Create a secure channel
16+
channel = grpc.secure_channel(
17+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
18+
19+
# Create a stub
20+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
21+
22+
# Create templates stub
23+
templatesStub = a_rpc_templates_pb2_grpc.TemplatesStub(channel)
24+
25+
# Create template
26+
templateRequest = template_pb2.DefaultTemplateRequest()
27+
templateRequest.Protocol = "SINGLE_USE_COUPON"
28+
templateRequest.Revision = 1
29+
30+
template = templatesStub.getDefaultTemplate(templateRequest)
31+
32+
template.Name = "Quickstart Base Offer"
33+
template.Description = "Quickstart Base Offer Pass"
34+
template.Timezone = "Europe/London"
35+
36+
templateId = templatesStub.createTemplate(template)
37+
38+
# Create offer
39+
offer = offer_pb2.CouponOffer()
40+
offer.Id = "Base Offer"
41+
offer.OfferTitle = "Base Offer Title"
42+
offer.OfferShortTitle = "Base Offer"
43+
offer.OfferDetails = "Base Offer Details"
44+
offer.OfferFinePrint = "Base Offer fine print"
45+
offer.BeforeRedeemPassTemplateId(templateId.Id)
46+
47+
issueStartDate = datetime.datetime.strptime(
48+
"10/9/2023", "%d/%m/%Y").timestamp()
49+
issueEndDate = datetime.datetime.strptime(
50+
"10/11/2023", "%d/%m/%Y").timestamp()
51+
redemptionStartDate = datetime.datetime.strptime(
52+
"10/9/2023", "%d/%m/%Y").timestamp()
53+
redemptionEndDate = datetime.datetime.strptime(
54+
"10/11/2023", "%d/%m/%Y").timestamp()
55+
56+
redemptionSettings = offer_pb2.RedemptionSettings()
57+
redemptionSettings.RedemptionStartDate = timestamp_pb2.Timestamp(
58+
redemptionStartDate)
59+
redemptionSettings.RedemptionEndDate = timestamp_pb2.Timestamp(
60+
redemptionEndDate)
61+
62+
couponExpirySettings = offer_pb2.CouponExpirySettings
63+
couponExpirySettings.CouponExpiryType = "AUTO_EXPIRE_REDEMPTION_END_DATE"
64+
65+
offer.IssueStartDate = timestamp_pb2.Timestamp(issueStartDate)
66+
offer.IssueEndDate = timestamp_pb2.Timestamp(issueEndDate)
67+
offer.RedemptionSettings = redemptionSettings
68+
offer.CouponExpirySettings = couponExpirySettings
69+
offer.CampaignId = "" # Get from campaignId from createCampaign call or dashboard
70+
offer.IanaTimezone = "Europe/London"
71+
response = couponsStub.createCouponOffer(offer)
72+
print(response)
73+
74+
75+
create_offer()

‎coupons/list-coupons.py

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import grpc
2+
import io.single_use_coupons.coupon_pb2 as coupon_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
5+
6+
def list_coupons():
7+
# Create channel credentials
8+
credentials = grpc.ssl_channel_credentials(
9+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
10+
11+
# Create a secure channel
12+
channel = grpc.secure_channel(
13+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
14+
15+
# Create a stub
16+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
17+
18+
# List coupons by campaignId
19+
listCouponRequest = coupon_pb2.ListRequest()
20+
listCouponRequest.CouponCampaignId = "" # Campaign Id of coupons to list
21+
22+
response = couponsStub.listCouponsByCouponCampaign(listCouponRequest)
23+
print(response)
24+
25+
26+
list_coupons()

‎coupons/redeem-coupon.py

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import grpc
2+
import io.single_use_coupons.coupon_pb2 as coupon_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
5+
6+
def redeem_coupon():
7+
# Create channel credentials
8+
credentials = grpc.ssl_channel_credentials(
9+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
10+
11+
# Create a secure channel
12+
channel = grpc.secure_channel(
13+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
14+
15+
# Create a stub
16+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
17+
18+
# Redeem coupon
19+
coupon = coupon_pb2.Coupon()
20+
coupon.Id = "" # Id of coupon to void
21+
coupon.CampaignId = "" # Get campaignId from createCampaign call or dashboard
22+
coupon.Status = 1
23+
24+
response = couponsStub.redeemCoupon(coupon)
25+
print(response)
26+
27+
28+
redeem_coupon()

‎coupons/update-coupon.py

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import grpc
2+
import io.single_use_coupons.coupon_pb2 as coupon_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
import io.common.personal_pb2 as personal_pb2
5+
6+
7+
def update_coupon():
8+
# Create channel credentials
9+
credentials = grpc.ssl_channel_credentials(
10+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
11+
12+
# Create a secure channel
13+
channel = grpc.secure_channel(
14+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
15+
16+
# Create a stub
17+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
18+
19+
# Update coupon
20+
coupon = coupon_pb2.Coupon()
21+
coupon.Id = "" # Id of coupon to update
22+
coupon.OfferId = "" # Get offerId from createOffer call or dashboard
23+
coupon.CampaignId = "" # Get campaignId from createCampaign call or dashboard
24+
25+
person = personal_pb2.Person()
26+
person.DisplayName = "Loyal Larry"
27+
person.EmailAddress = ""
28+
29+
coupon.Person = person
30+
response = couponsStub.updateCoupon(coupon)
31+
print(response)
32+
33+
34+
update_coupon()

‎coupons/void-coupon.py

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import grpc
2+
import io.single_use_coupons.coupon_pb2 as coupon_pb2
3+
import io.single_use_coupons.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
5+
6+
def void_coupon():
7+
# Create channel credentials
8+
credentials = grpc.ssl_channel_credentials(
9+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
10+
11+
# Create a secure channel
12+
channel = grpc.secure_channel(
13+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
14+
15+
# Create a stub
16+
couponsStub = a_rpc_pb2_grpc.SingleUseCouponsStub(channel)
17+
18+
# Void coupon
19+
coupon = coupon_pb2.Coupon()
20+
coupon.Id = "" # Id of coupon to void
21+
coupon.OfferId = "" # Get offerId from createOffer call or dashboard
22+
coupon.CampaignId = "" # Get campaignId from createCampaign call or dashboard
23+
24+
response = couponsStub.update(coupon)
25+
print(response)
26+
27+
28+
void_coupon()

‎flights/create-airport.py

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import grpc
2+
import io.flights.airport_pb2 as airport_pb2
3+
import io.flights.a_rpc_pb2_grpc as a_rpc_pb2_grpc
4+
5+
6+
def create_airport():
7+
# Create channel credentials
8+
credentials = grpc.ssl_channel_credentials(
9+
root_certificates='certs/certificate.pem', private_key_file='certs/key.pem', certificate_chain_file='certs/ca-chain.pem')
10+
11+
# Create a secure channel
12+
channel = grpc.secure_channel(
13+
'grpc.pub1.passkit.io' + ':' + '443', credentials)
14+
15+
# Create a stub
16+
flightsStub = a_rpc_pb2_grpc.FlightsStub(channel)
17+
18+
# Create airport
19+
airport = airport_pb2.Port()
20+
airport.AirportName = "ABC Airport"
21+
airport.CityName = "London"
22+
airport.IataAirportCode = "" # Your airport IATA code
23+
airport.IcaoAirportCode = "" # Your airport ICAO code
24+
airport.CountryCode = "IE"
25+
airport.Timezone("Europe/London")
26+
27+
response = flightsStub.createPort(airport)
28+
print(response)
29+
30+
31+
create_airport()

0 commit comments

Comments
 (0)