User and Content APIs

Authentication

EdCast Developer APIs use JWT authentication standard to access the Developer API's. Developer API's requires JWT-TOKEN to be passed in the header of every request.

To generate the JWT Token, it is required to

  1. Create a Role with developer Permission


  1. Create a user with Admin & the above role


  1. Generate API Key & Secret

JWT token can be generated making a call to the below API endpoint.

GET /api/developer/v5/auth

This API requires X-API-KEY and X-AUTH-TOKEN in the request header.

The X-API-KEY is the API key that we generated from the Edcast Admin above

Generate X-AUTH-TOKEN using online JWT encoding service like https://jwt.io
the payload should contain the email id as below
{ email: "[email protected]" }
& the Secret generated from the Edcast Admin above


Example Request

curl --location --request GET "https://BASE-ORG-URL/api/developer/v5/auth" \
 --header "X-API-KEY : <API-KEY>" \
 --header "X-AUTH-TOKEN: <JWT.encode(payload, secret_key)>"

Example Response

200 - OK  
    {  
       jwt_token: "nkdnlkikjf4753408yhlsdkbfhb43rgcdjbvjkh8fyu"  
    }

There are 2 Developer APIs for Edcast.

  1. User APIs - This is the API to update user information in Edcast LXP.
  2. Content APIs - This is the API to update user information in Edcast LXP.

API Endpoints

For more information on the API endpoints, please use the below Link : https://documenter.getpostman.com/view/1465156/RW8FERBE?version=latest#c7de3a2b-dfc5-4e55-9e00-b68d8d692ac8


Throttling

The requests to the Developer APIs are throttled at 10 requests per 10 seconds
The API responds with HTTP status 429 if this limit is exceeded