Implementation
An overview of integrating with the MeetBit Public API
Using the MeetBit Public API allows you to utilize features of the MeetBit Platform within your application. Whether you’re outsourcing certain features (like video conferencing) to MeetBit, or simply implementing your own custom user experience, this page will guide you through the basics.
General Flow
Regardless of the action you are trying to perform (like create an Online Conference), the process usually starts when your user clicks a button on your frontend application1. Your frontend application will then make a request to your backend application2. There, you may make certain processes before calling the MeetBit Public API3. After the MeetBit Public API responds4, your backend application can then process this and then respond to the ongoing request5. When successful, your frontend application can then display the result back to the user6.
User Mapping
Many actions within the MeetBit Platform require a User or a Customer (like joining an Online Conference). In these situations you have to map your own user objects to the appropriate resource object in the MeetBit Platform.
Mapping Scenarios
Below is a quick guide to understand which MeetBit resource object you should map your own user object to:
- When to map to a MeetBit User:
- Your user can “own” other MeetBit resource objects
- Your user can perform create, update, delete or other similar actions on other MeetBit resource objects
- When to map to a MeetBit Customer:
- Your user is only a “user” of MeetBit resource objects. E.g.:
- Schedules MeetBit Meeting Links
- Responds to MeetBit Forms
- Joins MeetBit Online Conferences
- Your user is only a “user” of MeetBit resource objects. E.g.:
- When there’s no need to map:
- Your user only views MeetBit resource objects
- Your user does not interact with MeetBit at all
As your application may have multiple user types, you may have to map your users differently (or not map a subset of them at all). However, in no situation should you map your user to both a MeetBit User and Customer at the same time.
To further understand the differences between Users and Customers in MeetBit, you may refer to the main MeetBit Documentation site.
Implementation
To map your users to MeetBit Users / Customers, you may add a meetbit_user_id / meetbit_customer_id attribute to your user resource object in the database. You can populate these attributes using the IDs returned when creating the MeetBit User or Customer resource object.
| Attribute | Data Type |
|---|---|
| meetbit_user_id | integer |
| meetbit_customer_id | integer |
We recommend that this mapping is performed at the earliest possible moment. Ideally during user creation / registration.
You must maintain user parity in both systems. Whenever you update and delete your users, you must perform the same actions to the corresponding MeetBit User / Customer.
Mapping Other Resource Objects
The process used for User Mapping can be applied to all other resource objects from the MeetBit Platform.
For example, in an online doctor appointment system, you must also map your doctor appointments to specific Online Conferences in MeetBit as these are created.
Specific Guides
Below are specific guides when using MeetBit in certain use cases.