Getting Started With the PAR Punchh Integration

Overview

The PAR Punchh Integrations Team requires varying levels of procedural steps to be completed as part of every integration with a third-party vendor or partner. The following describes a three-step process to integrate with PAR Punchh:

1. Contract

2. Develop

3. Launch

Depending on the type of the integration, the third-party vendor or partner is required to follow one of the following processes: 

Type 1 - This process is intended for integrations that are built to be generally available. This is meant for extensible integrations that can support use cases for a broad set of customers. 

Type 2 - This process is intended for integrations that are built with a limited feature set or custom requirements. Typically, these are integrations built for single customer use only with very specific use cases. 

Note: The following process is applicable only if the third-party vendor or partner would like to integrate with Punchh external APIs or the Webhooks Manager listed on the PAR Developer Portal here. If the extent of the integration is, for example, redirection to a customer login page or registration iFrame, then this integration process is not applicable.

The Process

To integrate with Punchh, first and foremost, we recommend that you:

1. Understand the Punchh partner integration process here.

2. Familiarize yourself with the resources available to you here.

3. Grasp the basic Punchh loyalty concepts here.

Partner Integration Process Type 1 - General Availability Integration Steps

Step	Description
Step 1	Partner reaches out to Punchh representative with proposed scope for the integration.
Step 2	Punchh Integrations Team reviews scope, assesses internal roadmap, and approves integration request.
Step 3	Partner Registration Form – Captures details about integration and software security aspects Feature Matrix – Lists base and recommended use cases to develop for POS, Kiosk, Online Ordering, Mobile, and Pay-on-the-Go integrations API License Agreement – A non-negotiable legal document related to consumption of Punchh APIs / Webhooks Manager High-Level Design Document – Depicts the high-level user and design flows for the integration
Step 4	Agenda for the discovery and technical scoping call: Discuss use cases in scope; review Feature Matrix Punchh APIs / Webhooks Manager endpoints to be consumed for the integration Integration development phases (if any)
Step 5	Punchh drafts the SOW (based on technical scoping calls) and sends to partner for signature.
Step 6	Q&A Community (Stack Overflow) – For partner to seek answers to product or development related questions Certification Matrix (if applicable) – For POS, Kiosk, Online Ordering, Mobile, and Pay-on-the-Go integrations, Punchh provides test cases for partner to perform self-certification / QA Developer Tool Pack (e.g., Postman API collection, libraries, etc.)
Step 7	Understand the Punchh API Security Guidelines and other guidelines on the PAR Developer Portal to follow during development.
Step 8	Partner performs QA to self-certify the integration For POS, Kiosk, Online Ordering, Mobile, and Pay-on-the-Go integrations, partner must use test cases listed in Certification Matrix for QA. When self-certification is complete, partner is required to submit Certification Matrix to Punchh Integrations Team for formal verification of the integration.
Step 9	Agenda for verification call with the Punchh Integrations Team: Partner demos key use cases implemented Partner provides a walkthrough of the completed Certification Matrix Partner provides Go/No-Go for launch
Step 10	Partner provides a GTM summary document to prepare for launch Partner requests access to production (API keys) from Punchh representative

Partner Integration Process Type 2 - Limited Availability Integration Steps

Step	Description
Step 1	Partner reaches out to Punchh representative with proposed scope for the integration.
Step 2	Punchh Integrations Team reviews proposed scope, assesses internal roadmap, and approves integration request.
Step 3	Partner Registration Form – Captures details about integration and software security aspects Feature Matrix – Lists base and recommended use cases to develop for POS, Kiosk, Online Ordering, Mobile, and Pay-on-the-Go integrations API License Agreement – A non-negotiable legal document related to consumption of Punchh APIs / Webhooks Manager High-Level Design Document – Depicts the high-level user and design flows for the integration
Step 4	Punchh Integrations Team reviews design document and aligns on the scope of integration with the partner Depending on the scope and complexity of the integration, Punchh may require verification and will inform the partner about it
Step 5	Q&A Community (Stack Overflow) – For partner to seek answers to product or development related questions Certification Matrix (if applicable) – For POS, Kiosk, Online Ordering, Mobile, and Pay-on-the-Go integrations, Punchh provides test cases for partner to perform self-certification / QA Developer Tool Pack (e.g., Postman API collection, libraries, etc.)
Step 6	Understand the Punchh API Security Guidelines and other guidelines on the PAR Developer Portal to follow during development Partner finishes development and performs QA to self-certify the integration
Step 7	Agenda for verification call with the Punchh Integrations Team: Partner demos key use cases implemented Partner provides a walkthrough of the completed Certification Matrix (if applicable) Punchh provides Go/No-Go for launch
Step 8	Partner requests access to production (API keys) from Punchh representative.

Resources

Contract

• Punchh Value Prop Template
• Punchh Partner Registration Form
• Punchh API License Agreement
• Punchh High-Level Design Document Template

Develop

• Punchh University
• Punchh Support Portal
• Punchh Standard Integration Feature and Certification Matrices
• Punchh Postman API Collection
• Punchh Product & Technology Q&A Community

Launch

• Punchh GTM Summary Document Template

Basic Concepts

Here is the prerequisite reading applicable to all loyalty integrations:

• Punchh Offers and Program Types
• Punchh Base URIs
• Getting Started With Punchh APIs
• Punchh API Security Guidelines
• Overview of Webhooks Manager

Punchh Support Portal

The Punchh Support Portal contains an extensive knowledge base with FAQs as well as the Punchh product documentation, including:

• Platform user guides
• POS installation/configuration guides
• Platform and POS release notes
• Partner-enablement guides

To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions here to access the Punchh Support Portal.

Punchh Developer Q&A Community

The Punchh External Developer Community Q&A site, hosted by Stack Overflow, is intended to serve as a supplement to the Punchh Developer Portal so that developers working on integrations with the Punchh platform can share information. This community site is a valuable resource where you can post your questions to get answers, tips, and tricks, as well as respond to questions posted by others. For details, see this article on the Punchh Support Portal.