Download the PHP package coviu/coviu-sdk without Composer
On this page you can find all versions of the php package coviu/coviu-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download coviu/coviu-sdk
More information about coviu/coviu-sdk
Files in coviu/coviu-sdk
Package coviu-sdk
Short Description A simple library to use the Coviu API.
License MIT
Homepage https://github.com/coviu/coviu-php-sdk
Informations about the package coviu-sdk
coviu-php-sdk - Coviu api php client library
Coviu provides a session based API for creating and restricting access to coviu calls. The core concepts exposed are
- Session: A coviu call that occurs between two or more parties at a specified time, and has a finite duration.
- Participants: Users who may participate in a coviu call.
Participants join a call by following a session link in their browser, or mobile app. The session link identifies the participant, including their name, optional avatar, and importantly their role. As such, it is important that each person joining the call be issued a different session link, i.e. have a distinct participant created for them. A participant's role identifies whether that user may access the call directly, or if they are required the be let in by an existing participant.
coviu-php-sdk exposes this functionality through a convenient php library.
There is a demo for how to use the SDK at https://github.com/coviu/coviu-api-php-demo . Also check out the Wordpress plugin at https://github.com/coviu/coviu-video-calls which has a more detailed use.
Installation
If you are not using composer in your application, still run the above command, which creates a vendor
directory. Then commit the vendor directory into your codebase. You can get composer
from https://getcomposer.org/download/ . You can check Coviu's composer package at https://packagist.org/packages/coviu/coviu-sdk .
If you'd like to get a full tarball with the vendor directory, contact [email protected] .
Quickstart
Setup the sdk by passing in your api key and key secret
Schedule a session for the future.
Example output
$coviu->sessions->*
is a collection of functions that build requests that can be run against the api.
You can now add a participant to the session
Example output
Notice the entry_url
for the newly created participant. Following this url in a browser or in one of the coviu mobile apps
between start_time
and end_time
(while the session is active), will join the participant into the session, assuming
the role and identity provided.
We can now read the entire session structure back
Example output
There's a full set of api documents provided with api source for the coviu-sdk-api
npm module at /src/SessionApi.php
OAuth2
Coviu implements the OAuth2 authorization code flow https://tools.ietf.org/html/rfc6749#section-4.1. Coviu requires that you
register you redirect_url
ahead of time in Applications
section of your api team account. Once a user
has returned with a authorization code, you may recover the access token and refresh token by using the authorizationCode