API Management Service

The API management microservice provides services to create, manage and validate API tokens to register mobile and desktop apps, and to issue and refresh API tokens of registered mobile and desktop app devices.

Get a new bearer token

This API is used to obtain a bearer token

• Required fields cannot be left null or empty

POSThttps://staging.open-sunbird.org/api//api-manager/v1/consumer/{consumer}/credential/register

Path parameters

consumer*string

Append any text to the request URL

Example: "mobile_device"

Body

application/json

A unique value which helps in identifying the token

request*object

Response

200400415500

OK

Body

application/json

idstring

Represents the api id

verstring

Represents the api version

tsinteger (int64)

Represents the EPOCH epoch time in milliseconds

paramsobject

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api//api-manager/v1/consumer/{consumer}/credential/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "key": "text"
      }
    }),
});
const data = await response.json();

Response

200400415500

{
  "id": "text",
  "ver": "text",
  "params": {
    "status": "success",
    "err": "text",
    "errmsg": "text",
    "msgid": "text",
    "resmsgid": "text"
  },
  "result": {
    "key": "text",
    "secret": "text",
    "token": "text"
  }
}

Get a new bearer token

This API is used to obtain a bearer token

• Required fields cannot be left null or empty

POSThttps://staging.open-sunbird.org/api//api-manager/v2/consumer/{consumer}/credential/register

Path parameters

consumer*string

Append any text to the request URL

Example: "mobile_device"

Body

application/json

A unique value which helps in identifying the token

request*object

Response

200400415500

OK

Body

application/json

idstring

Represents the api id

verstring

Represents the api version

tsinteger (int64)

Represents the EPOCH epoch time in milliseconds

paramsobject

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api//api-manager/v2/consumer/{consumer}/credential/register', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "key": "text"
      }
    }),
});
const data = await response.json();

Response

200400415500

{
  "id": "text",
  "ver": "text",
  "params": {
    "status": "success",
    "err": "text",
    "errmsg": "text",
    "msgid": "text",
    "resmsgid": "text"
  },
  "result": {
    "key": "text",
    "secret": "text",
    "token": "text"
  }
}

Get a new access token

This API is used to obtain a new access token

• Required fields cannot be left null or empty

POSThttps://staging.open-sunbird.org/api//auth/v1/refresh/token

Body

application/x-www-form-urlencoded

The refresh token obtained from the server

refresh_token*string

Response

200400415500

OK

Body

application/json

idstring

Represents the api id

verstring

Represents the api version

tsinteger (int64)

Represents the EPOCH epoch time in milliseconds

paramsobject

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api//auth/v1/refresh/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "refresh_token": "text"
    }),
});
const data = await response.json();

Response

200400415500

{
  "id": "text",
  "ver": "text",
  "params": {
    "resmsgid": "text",
    "status": "success",
    "err": "text",
    "errmsg": "text"
  },
  "result": {
    "access_token": "text",
    "refresh_token": "text"
  }
}

Get API token

This API is used to get the token.

• /consumer/desktop_device/credential/register/ endpoint helps to get the token.
• Required fields cannot be left null or empty

POSThttps://staging.open-sunbird.org/api/api-manager/v2/consumer/desktop_device/credential/register

Header parameters

Body

*/*

'The body parameter refers to the format of the request, the request body (payload) takes the following media types to make the payload:'

• JSON
  The body is the representation of the resource object to get the token

request*RegistryObject

Response

200500

SUCCESS. The operation was successful!

Body

application/json

idstring

Represents the unique API Identifier

verstring

Represents the API version information

etsnumber

Represents the current time stamp

paramsResponse Parameter

resultToken details

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/api-manager/v2/consumer/desktop_device/credential/register', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*",
      "Authorization": "text"
    },
    body: JSON.stringify({
      "request": {
        "key": "text"
      }
    }),
});
const data = await response.json();

Response

200500

{
  "id": "text",
  "ver": "text",
  "ets": 0,
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "result": {
    "key": "text",
    "secret": "text",
    "token": "text"
  }
}