REST API Overview

The REST APIs are exposed as simple REST services. You can use any REST library indigenous to your backend technology stack.

All requests are made to our secure backend at https://pcast.phenixrts.com. We strongly encourage you to use the https endpoint. Phenix may stop supporting its less secure counterpart at any time.

Authentication is required for working with our HTTP APIs. Currently there are 2 ways of sending credentials in the request.

Pass credentials for authentication using the HTTP Authorization request header as shown:

Authorization: <type> <credentials>

1. Combine the applicationId and the secret with a colon applicationId:secret
2. base64 encoded the resulting string YXBwbGljYXRpb25JZDpzZWNyZXQ=

For example:

1POST /pcast/composition HTTP/1.1
2Host: pcast.phenixrts.com
3Accept: application/json
4Content-Type: application/json
5Content-Length: 249
6Authorization: Basic YXBwbGljYXRpb25JZDpzZWNyZXQ=

1curl https://pcast.phenixrts.com/pcast/composition \
2-H "Accept: application/json" \
3-H "Content-Type: application/json" \
4-H "Content-Length: 249" \
5-u "applicationId:secret" \

You can pass credentials in the request body as shown:

1{
2    "credentials": {
3        "applicationId": "<applicationId>",
4        "secret": "<secret>"
5    }
6}

Passing the Credentials in request body is deprecated and supported only for backward compatibility. The preferred way of passing the Credentials is through HTTP Authentication Header

You can terminate any of your streams using a DELETE request. Typically, a stream will be terminated through the client API and this REST API may be used to censor streams.

1DELETE /pcast/stream HTTP/1.1
2Host: pcast.phenixrts.com
3Accept: application/json
4Content-Type: application/json
5Content-Length: 124
6
7{
8    "applicationId": "<applicationId>",
9    "secret": "<secret>",
10    "streamId": "<streamId>",
11    "reason": "<reason>"
12}

1curl https://pcast.phenixrts.com/pcast/stream \
2-H "Accept: application/json" \
3-H "Content-Type: application/json" \
4-X DELETE \
5-d '{
6        "applicationId": "<applicationId>",
7        "secret": "<secret>",
8        "streamId": "<streamId>",
9        "reason": "<reason>",
10    }'

The platform will return a successful response that contains a "status" field. The HTTP status code is set according to the "status" field.

1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Content-Length: 15
4
5{"status":"ok"}

1{
2    "status":"ok"
3}