Welcome to Hey Pongo's API guide!

This API guide aims at providing the resources to help you develop your own integration of our loyalty experience product on your platform.

🌟 How to get your integration live with Pongo?

1. 🆙 Request API Access

Our API is not publicly accessible. To initiate your integration and testing within our Sandbox environment, please request access by sending a mail to [email protected]

The Partnership team will assess your application, and if approved, you will receive an email containing the credentials required for your implementation.

2. Explore Guidelines and API Reference

After gaining access to our API within the Sandbox environment, you can begin calling our endpoints and developing your integration.

We strongly recommend following our guidelines, as your integration will need validation by our quality assurance team before it can be accepted and launched on our platform.

3. 👷 Development

Should you encounter any challenges during the development process, please don't hesitate to contact our technical support at [email protected].

4🚦Submit Your Integration for Review

Once your development work is complete, you can contact us at [email protected] with the following:

• Provide access to a test account in your environment to allow our team to perform End-to-End tests of your integration.
• Submit a video demonstrating the user experience, including configuration and use cases.
• Documentation regarding the configuration and set up.

Those elements are needed to provide training to our customer facing teams. Our company is often (if not always) the first touchpoint when a customer has an issue or a request to use Pongo with a third party system.

Our team will assess the quality of your integration in line with our guidelines and performance requirements and provide you with feedback.

5. 🚀 Prepare for Going Live!

Congratulations! 🎉
You have successfully passed our quality assurance review. It is now time to launch your integration and test it in a real-world environment.

Typically, we initially release the integration to a select group of customers for final testing and quick adjustments in the event of any issues.

Once these tests prove successful, we can officially launch your integration on our marketplace! 🎆

📝 Guidelines

Our primary objective is to offer various touchpoint integrations that empower our customers to connect with their audience and provide them with an exceptional loyalty experience.

To achieve this goal, we have formulated guidelines to assist you in creating an integration that aligns with our specifications and ensures a level of quality that enhances our company and product.

As of today, we have established guidelines for the following types of integrations:

• Point of Sale (🚧 WIP)
• Order Kiosk (🚧 WIP)
• Ordering System (Click & Collect, Order & Pay)
• Payment Terminal

💬 We're here to help!

If you get stuck, shoot us an email and the tech team will help you.

We're excited to see your integration with our platform and create the best loyalty experience on the market! 💜