Cameyo API provides a set of service endpoints that allows administrators to use APIs to programatically provision servers, users and user groups, and apps.
Cameyo API syntax
Calls are made through the HTTPS GET method. Cameyo APIs use the following syntax:
https://online.cameyo.com/resource-id/action?clientId=your-client-id&clientSecret=your-client-secret
To generate your client secret:
- On the Cameyo Admin console, select Admin
> Company Settings > Advanced.
- Under Properties, make a note of your Company ID. You will use this as client ID in API calls.
- Select API client secret > Generate.
For example, to add a new user, the syntax is:
https://online.cameyo.com/users/add?clientId=...&clientSecret=...&user=newuser@company.com
Success response:
{
"success":true,
"code":200,
"message":"NoA5c3CLVjXQyMx9"
}
Service endpoints
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://online.cameyo.com/resource-id/
Resource IDs
Identifiers used are:
- GUIDs for servers, users and user groups
- Numeric IDs for apps
Authentication method
The API provides two ways to authenticate, both of which use the Company ID and the API client secret. You can either use those as:
- username and password in a basic HTTP authentication
- use clientId and clientSecret HTTP parameters