The Webinar FM API is a RESTful Web Service.
\nIt accepts requests using standard HTTP methods, such as GET, PUT, POST and DELETE. Currently, “Basic HTTP Authentication” is the only available method of authenticating. We are working to additionally provide “Digest HTTP Authentication”.
\nExamples given here are provided for the PHP programming language and uses cURL to make the HTTP requests.
\ninput_type and rest_data variable, the former must be set to “json” and the latter must be a valid JSON array, such as input_type=json&rest_data={\"id\":\"1\",\"var2\":\"val2\"}The JSON approach is robust as it allows the passing of objects and arrays whilst also being simpler to implement (simply json_encode() your data array before sending it). We provide PHP code examples for how requests are made with each API method below.
\nIn the future, we may allow for additional input_type (such as XML), but for the time being you must always set this to “json”.
\nThere is more choice available for return formats — take a look at the section called “Return Formatting” below.
\nTo access the Webinar FM API methods you must pass the Authorization header as part of each request, set it to basic and pass the required encrypted string. For example:
\nAuthorization: Basic am9obmRvZTpwYXNzd29yZA==
The encrypted string must be a base64 encoded combination of username and password in the following format:
\nmyUsername:myPassword
In Fiddler you can create this string by opening the Encoder tab, selecting base64 and entering your credentials.
\nNote when using non-latin usernames: you can use a normal browser to test GET methods. You will be asked to provide username/password in a popup, which is passed to the server as HTTP Basic Auth. Note that not all browsers support non-latin characters during this authentication. Chrome works, Firefox and others do not support it. This is only an issue when testing with a browser. cURL has no such issues.
\nPostman — HTTP Web Debugger. Allows you to send GET, PUT, POST, DELETE and other HTTP requests, modify headers and request body, and capture the return values. Essential for testing and debugging your API integration.
\n“RESTful Web Services” by Leonard Richardson & Sam Ruby (O’Reilly) — some formulations in this document have been borrowed from this excellent book, in particular for the section on HTTP Error Codes.
\n[ver] - The version of the API endpoint, must be defined in each request URL. The current version is 2.
\nExample: GET http://domain.com/api/2/[username]/authverify
\n[username] - The username of the account which is making the API requests.
\nExample: GET http://domain.com/api/[ver]/johndoe/authverify
\nReturned when providing input during a PUT operation which would leave the resource in an incomplete or inconsistent state. The provided input is nonsensical or corrupt.
\nExample: Providing an alphabetic value of “abcd” for an integer parameter, such as “offset”.
\nReturned when trying to operate on a protected resource without providing the proper authentication credentials (either wrong or none at all). The response header WWW-Authenticate describes what kind of authentication the server will accept.
\nReturned when trying to access a URI that does not correspond to any existing resource. The only possible exception is when a client is trying to PUT a new resource to that URI, see 201.
\nExample: Trying to retrieve a non-existing user.
\nReturned when the client tries to use an HTTP method which this particular resource doesn’t support.
\nExample: Trying to PUT or DELETE a read-only resource.
\nReturned when providing input during a PUT operation which would cause the resource state to conflict with some other resource.
\nExample: Trying to change your username to a name that’s already taken. Trying to delete a folder that is not empty.
\nReturned when the server knows there used to be a resource there, but there isn’t anymore. Also see 404, when the server has no idea about the resource at all.
\nThere is a problem on the server side.
\nReturned when a GET operation is successful, a POST operation to append to an existing resource is successful, and when a DELETE operation is successful.
\nWhen a successful PUT or POST (when creating new) operation is carried out a 201 is returned, along with the new URI in the Location header. See 400 and 409 for related error codes.
\nSometimes a PUT operation will change the URI of the resource just modified. In such cases, a 301 is returned, along with the new URI in the Location header. Future requests to the old URI will result in a 301, 404 or 410 return.
\nThe Webinar FM API supports a number of different return formats.
\nBy appending /format/[value]/ to the URLs of the API method calls, or by passing the correct MIME-type, you can choose the format of the returned data. These may differ for each call, so, for example you may wish to obtain a list of users in XML format, but get a list of invitees returned in JSON.
\n| Format | \nURL Parameter | \nSample return | \n
|---|---|---|
| xml | \nnone (default) or /format/xml | \n<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<xml>\n <item>\n <id>1</id>\n <login>username</login>\n <email>email@domain.com</email>\n <first_name>First Name</first_name>\n <last_name>Last Name</last_name>\n [...]\n </item>\n</xml>\n | \n
| json | \n/format/json | \n[\n {\n \"id\": \"1\",\n \"login\": \"username\",\n \"email\": \"email@domain.com\",\n \"first_name\": \"First Name\",\n \"last_name\": \"Last Name\",\n [...]\n }\n]\n | \n
| serialize | \n/format/serialize | \na:1:\n{\n i:0;a:5:\n {\n s:2:\"id\";\n s:1:\"1\";\n s:5:\"login\";\n s:8:\"username\";\n s:5:\"email\";\n s:16:\"email@domain.com\";\n s:10:\"first_name\";\n s:10:\"First Name\";\n s:9:\"last_name\";\n s:9:\"Last Name\";\n [...]\n }\n}\n | \n
| php \n(can be used in eval) | \n/format/php | \narray (\n 0 =>\n array (\n 'id' => '1',\n 'login' => 'username',\n 'email' => 'email@domain.com',\n 'first_name' => 'First Name',\n 'last_name' => 'Last Name',\n [...]\n )\n)\n | \n
| html | \n/format/html | \n<table border=\"0\" cellpadding=\"4\" cellspacing=\"0\">\n <tr>\n <th>id</th>\n <th>login</th>\n <th>email</th>\n <th>first_name</th>\n <th>last_name</th>\n <th>[...]</th>\n </tr>\n <tr>\n <td>1</td>\n <td>username</td>\n <td>email@domain.com</td>\n <td>First Name</td>\n <td>Last Name</td>\n <td>[...]</td>\n </tr>\n</table>\n | \n
| csv | \n/format/csv | \nid,login,email,first_name,last_name,[...]\n1,\"username\",\"email@domain.com\",\"First Name\",\"Last Name\",[...]\n | \n
Use to test if the auth credentials passed with HTTP Basic are valid.
\nWebinar FM REST API Documentation
\n","event":[{"listen":"prerequest","script":{"id":"9cbf3334-effb-4629-ab2f-94457ff5d664","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7ba3ec1-c1eb-4aa9-9a0e-2d0a108a8e6b","type":"text/javascript","exec":[""]}}],"_postman_id":"45cf640c-e264-4e8e-87ab-e6af0c609f80"},{"name":"Session invitees","item":[{"name":"/invitees/id/[int]","id":"6f9fd7f3-91a2-44df-8be2-4126456f8057","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user_name}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_EndPoint}}/api/2/{{user_name}}/invitees/id/{{session_id}}","description":"Get data of people invited to a session. All invitees are grouped into either moderators, participants or observers, depending on the role given to them when creating the session.
\nGet data of single person invited to a session.
\nAdd an invitee to a session.
\nModify the role of an invitee to a session.
\nDelete an invitee from a session.
\nDelete all invitees from a session. Available since 5.5.0.
\nStatistics can potentially return a very large amount of date. In addition to limiting the /days parameter, we recommend that you:
\nlimit type of data by using the /return option to define a subset of data fields.
\nUse the /count and /offset options to page through the results.
\nGet live connection statistics for the user’s account.
\nGet usage statistics
\n","_postman_id":"0199f806-33de-4458-82c7-ec39fe0b268c"},{"name":"Sessions","item":[{"name":"/sessions","id":"7bd8b1ea-07f6-47d5-95d6-612960a53d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Return list of sessions.
\nReturn session data by given id.
\nCreate a new session.
\nFull description will be available soon.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"56738ae2-e760-4232-aee1-d7ca38ffb987"},{"name":"/session","id":"5543f5bf-c0a6-454e-a661-dd5274d595dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"Edit an existing session.
\nFull description will be available soon.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5543f5bf-c0a6-454e-a661-dd5274d595dc"},{"name":"/session","id":"0f2b124a-4a6e-42df-b9e8-9c23487ec2be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"","description":"Delete an existing session.
\nFull description will be available soon.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0f2b124a-4a6e-42df-b9e8-9c23487ec2be"}],"id":"280f9a8d-3f68-4310-9fbc-062da4e87b9e","_postman_id":"280f9a8d-3f68-4310-9fbc-062da4e87b9e","description":""}],"event":[{"listen":"prerequest","script":{"id":"6286d154-e38b-4b90-b207-d9cd19719150","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1f4a2556-23d5-4b8b-b2bd-58bd205b198d","type":"text/javascript","exec":[""]}}]}