Start Apizee using the REST API
Integrate Apizee visual engagement plateform on a webpage by using REST APIs to generate the conference or ticket URLs
On this page, you will see how you can use Apizee REST APIs to integrate Apizee conferences and Apizee tickets into your into 3rd-party software.
This requires 2 steps :
Send invitations using the REST API
You can use the REST APIs to create video meetings and video assistance sessions, and to send invitations for these sessions.
Creating video meetings and video assistance sessions relies on different API endpoints.
Authenticate to REST API
In the following examples, you need to authenticate using a bearer token. You can get a bearer token using Apizee Cloud API swagger and filling in your credentials.
Create an Apizee conference
Conferences may be controlled using /api/v3/conferences API endpoint. Sending an HTTP POST request to this endpoint with appropriate parameters creates the conference.
The following example demonstrates how to dynamically generate and distribute pre-configured meeting URLs for Apizee Meet, passing most common parameters (such as API keys, conversation names, guest URLs, etc.):
Create an Apizee ticket
Tickets may be controlled using /api/v3/tickets API endpoint. Sending an HTTP POST request to this endpoint with appropriate parameters creates the ticket.
The following example demonstrates how to create a support ticket via the API, passing most common parameters. It also allows to retrieve its URL and to fetch the ticket information once the visual assistance session has ended:
Open the video assistance room in a new tab
Simply retrieve the URL through the REST API and insert it into an anchor link tag in your HTML page:
<a href="<RETRIEVED URL>" target="_blank">Start video chat</a>Last updated