Chapter 3 : Integration Workflow
Last updated
Was this helpful?
Last updated
Was this helpful?
Embarking on the integration journey with Chup! API involves a systematic workflow designed to simplify the process and ensure a seamless experience. The integration workflow between Chup and your Hospital Information System (HIS) involves a series of steps to ensure seamless communication and data synchronization. This chapter provides a detailed guide on the integration workflow, from authentication to handling errors.
Start by configuring the outgoing webhook on your clinic's settings page within the Chup platform.
A secret key is provided for you to validate the payload signature, using the HMAC-SHA-256 algorithm. This ensures the utmost security and integrity of the transmitted data.
Chup will automatically send updates regarding Live Queue, Appointments, and Client's data to the specified outgoing webhook URL whenever there is relevant activity.
Description
User Action: This is the specific action that the user takes, such as joining a live queue, scheduling an appointment, updating staff data, patient data, etc.
Generate Payload: This step creates the payload, which is a piece of JSON data that contains information about the user action.
Generate Payload Signature: This step signs the payload using a secret key and HMAC-SHA-256 algorithm. The signature is used to verify that the payload has not been tampered with.
Send Payload and Signature: This step sends the payload and signature to the merchant’s endpoint. The merchant’s endpoint is a URL that is used to receive webhook events.
You have the flexibility to communicate from your application to Chup using incoming webhooks.
The Chup platform provides an incoming webhook URL by default, easily accessible on your clinic's setting page.
For a demonstration, you can send a sample payload to the following endpoint
Description
Send Payload: Merchant sends the payload to the CHUP’s endpoint. The CHUP’s endpoint is a URL that is used to receive webhook events.
Parse & Process Payload: Chup receives the payload and extracts the data from the payload and formats it in a way that it can understand then takes some action.
Description
Send Payload: Merchant sends the request to the CHUP’s API endpoint.
Parse & Process Payload: Upon receiving the payload, Chup's API parses and processes the information.
Response: Based on the processed information, Chup sends a response back to the Merchant.
By following this comprehensive integration workflow, you'll navigate the Chup! API integration process with confidence, resulting in a seamlessly integrated Queue and Appointment Management solution that enhances your business operations.
