PARTNER PROGRAMME

A quick context about POS integration with UrbanPiper

Welcome to UrbanPiper API Program!

The UrbanPiper API is organized around REST. A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. For more details on REST you may visit this section.

In this documentation, you will find different pages to help you get started with UrbanPiper API integration and get a better technical understanding to implement the same.

Below is a quick summary of the topics we discuss in this documentation,

• Overview - a quick introduction to the architecture of HUB.

• Getting Started - understand the onboarding process for POS, the environments we provide, the sandbox and the webhooks required from you.

• Authentication - understand how to authenticate the API requests to UrbanPiper.

• Manage Stores - understand how to create a store or update an existing one.

• Managing Menu - understanding the UrbanPiper menu structure, and availability of Items and Options/Modifiers that make up the Menu.

• Receive/Manage Orders - understand how to receive orders, send and receive status updates and receive rider updates.

• Availability - understand how items/options can be stocked out and stores can be opened or closed for ordering

• Testing and Validation - understand how to perform an end to end testing and validate the entire implementation to make it go-live ready.

• Certification - understand how to get the integration certified from UrbanPiper

• Resources - know more about certain key elements or implementations

Before you head to the API Documentation for implementation, we strongly recommend you go through the guide to have a complete understanding of the requirements and components of the integration.