⚙️API Examples

Data Synchronization Using APIs in Chup Online

Data synchronization is a critical process in maintaining the consistency and accuracy of information across different systems. In the context of Chup Online, an API (Application Programming Interface) facilitates this by providing a set of rules and protocols for different software applications to communicate with each other. By leveraging APIs, Chup can synchronize data across various platforms and devices in real-time, ensuring that all stakeholders have access to the most current information.

Descriptions

• 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 Online sends a response back to the Merchant.

How APIs Work for Synchronization

The Chup Online API acts as an intermediary that allows for two-way communication between the Chup Online platform and external systems. When data is updated in one location, the API ensures that the change is reflected across all other systems that share this data. For instance, when a patient’s medical record is updated on the Clinic dashboard, the API can push this update to a centralized electronic health record system used by different healthcare providers.

APIs work by receiving requests for data and responding with the necessary information. This process is made possible through API endpoints, which are specific paths defined in the API that correspond to various data retrieval or update operations. When a request is sent to an endpoint, the API processes this request, interacts with the database or server where the data is stored, and returns the relevant data in a structured format JSON.

API Examples

This chapter provides a comprehensive guide to the API documentation for integrating ChupOnline with your Hospital Information System (HIS). Understanding the API endpoints, data formats, authentication mechanisms, and other key details is crucial for a successful integration.

Base URL

The base URL for Chup's API is https://chup.online/api/v1

API Credentials

Obtain the required API credentials (api key, business_id and email). These credentials are essential for authenticating API requests.

Chup Online API Credentials:

Bearer token: [Your bearer token]

Ensure that the API credentials have the necessary permissions to perform the required actions, such as fetching patient data, scheduling appointments, and updating records.

Authentication Click for demo

Chup Online uses OAuth 2.0 for secure authentication. To obtain access tokens, make a POST request to the token endpoint:

Request Headers

Header	Value
Accept	application/json
Content-Type	application/json
X-Requested-With	XMLHttpRequest

POST: https://chup.online/api/v1/user/auth/login

Example Body

{
  "email" : "[e-mail]",
  "password" : "your-password"
}

Example Response [Success]

{
  "code" : 200,
  "success" : true,
  "is_redirect" : false,
  "message" : "welcome back Admin",
  "data" : {
    "api_token" : "1|ikasd812ljasdnxxx...."
    "firebase_user_token" : "eyJ0eXAxxxxxx....."
  }
}

---

AuthChup API