API Introduction

Overview

The Khumbu API empowers developers to programmatically engage with Khumbu's ecosystem, purpose-built for Point-of-Sale (POS) & Integration Partners. Our platform provides standardized, efficient APIs to connect restaurant POS systems and integration partners, enabling streamlined processes for order management, Menu & Store updates, and real-time menu synchronization. Key capabilities include:

• Order Management: Seamlessly create, validate, and cancel orders.
• Menu Synchronisation: Maintain consistent and accurate menus across multiple systems.
• Store Synchronisation: Maintain consistent and accurate stores across multiple systems.
• Real-Time Notifications: Receive instant updates on order status changes, menu modifications, and other critical events.

API Testing on UAT and Production Environments

Testing APIs thoroughly in both UAT (User Acceptance Testing) and Production environments is crucial to ensure the seamless functioning of your integration with Khumbu APIs. Here’s a breakdown of the process:

1. API Testing on UAT Environment

The UAT environment is a sandbox designed for testing without impacting live data or production systems.

Steps for UAT Testing:

1. Obtain Sandbox Credentials and Details:
   1. Use the API Key and OAuth credentials provided for the UAT environment.
   2. Configure webhook, auth credentials and other settings with help of Khumbu Support team.
2. Set Up the UAT Base URL:
   1. Direct all API calls to the UAT base URL:
      https://api.uat.khumbu.com
3. Perform Comprehensive Testing:
   1. Validate authentication flows using OAuth credentials.
   2. Test endpoints for order creation, menu updates, store synchronization, and other key functionalities.
   3. Simulate error scenarios to ensure proper handling of failed requests.
   4. Test webhook configurations to confirm they receive and process events accurately.
4. Validate Business Logic:
   1. Ensure data consistency and proper behavior of the API integration under different scenarios.
   2. Check that all edge cases are handled effectively.
5. Monitor Logs and Debugging
   1. Use logging tools to track API requests and responses for debugging purposes.
   2. Resolve any issues before moving to production.

2. API Testing on Production Environment

Once the integration is fully validated in UAT, you can proceed to the production environment.

Steps for Production Testing:

1. Switch to Production URL: https://api.khumbu.com
2. Follow all the steps mentioned in UAT