Introduction
Apizee and ApiRTC REST APIs enable developers to manage video chat lifecycle and integrate valuable data into other systems.
What can you do with the Apizee REST APIs?
REST APIs split into 2 categories:
Linked to ApiRTC platform
Linked to the Apizee platform
Manage low level communication objects
Manage Apizee SaaS solutions objects
Available endpoints:
/session
/conversation
/sms
/email
/media
Available endpoints:
/users
/enterprises
/service
/tickets
/conferences
/hl7
Authentication is managed by a shared endpoint: /authentication
>> Try it now
Authentication
You need to be an Apizee or ApiRTC authenticated user to use the APIs.
Account on https://cloud.apirtc.com
x
Account on https://cloud.apizee.com
x
x
👉Create an account on the ApiRTC Console or on the Apizee plaform depending on what endpoint you need.
👉Use the /authentication
endpoint providing your username and password to get a token in return (see Bearer Authentication).
Be mindful that you get the authentication token by passing clear username and password along with your API call; this operation must be done by your application's backend to avoid security issues and NOT by your frontend part.
👉Include the token in the Authorization
header of requests:
Example of use:
Response
Compliant with the OpenAPI Standards
Webhooks
Design a two-way integration by enabling ApiRTC to push events to your systems.
Last updated