API Guide For Sunbird-RC

The APIs used in the certificate generation process are listed below. Kindly find the Postman collection file in the below link

https://github.com/Sunbird-Lern/lms-service/blob/release-8.0.0/api-tests/Collection/Sunbird-RC-Certificate-APIs.postman_collection.json

Create certificate

POSThttp://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate

Header parameters

Body

application/json

object

Example: "{\n \"recipient\": {\n \"id\": {{user id}},\n \"name\": {{user name}},\n \"type\": \"user\"\n },\n \"issuer\": {\n \"url\": {{issure url}},\n \"name\": {{issure name}},\n \"kid\": {{Public key osid}}\n },\n \"training\": {\n \"id\": {{course id}},\n \"name\": {{course name}},\n \"type\": \"Course\",\n \"batchId\": {{batch id}}\n },\n \"templateUrl\": {{template url}},\n \"status\": \"ACTIVE\",\n \"signatory\": [\n {\n \"name\": \"commissioner\",\n \"image\": {{base64 signatory}},\n \"designation\": \"CEO\",\n \"id\": \"CEO/CEO\"\n }\n ],\n \"oldId\": {{old certificate id if certificate is reissue}},\n \"certificateLabel\": {{certificate name}},\n \"issuedOn\": {{issued time}}\n}"

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"recipient\": {\n        \"id\": {{user id}},\n        \"name\": {{user name}},\n        \"type\": \"user\"\n    },\n    \"issuer\": {\n        \"url\": {{issure url}},\n        \"name\": {{issure name}},\n        \"kid\": {{Public key osid}}\n    },\n    \"training\": {\n        \"id\": {{course id}},\n        \"name\": {{course name}},\n        \"type\": \"Course\",\n        \"batchId\": {{batch id}}\n    },\n    \"templateUrl\": {{template url}},\n    \"status\": \"ACTIVE\",\n    \"signatory\": [\n        {\n            \"name\": \"commissioner\",\n            \"image\": {{base64 signatory}},\n            \"designation\": \"CEO\",\n            \"id\": \"CEO/CEO\"\n        }\n    ],\n    \"oldId\": {{old certificate id if certificate is reissue}},\n    \"certificateLabel\": {{certificate name}},\n    \"issuedOn\": {{issued time}}\n}"),
});
const data = await response.json();

Create PublicKey

POSThttp://{{rc_private_host}}/registry-service/api/v1/PublicKey

Header parameters

Body

application/json

object

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/PublicKey', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": "{{key}}"
    }),
});
const data = await response.json();

Download certificate PDF

GEThttp://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}

Path parameters

osid*string

Header parameters

Response

undefined

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

undefined

text

Update certificate

PUThttp://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}

Path parameters

osid*string

Header parameters

Body

application/json

object

Example: "{\n /// updated fields\n}"

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    /// updated fields\n}"),
});
const data = await response.json();

delete certificate

DELETEhttp://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}

Path parameters

osid*string

Header parameters

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/{osid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Search Certificate

POSThttp://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/search

Header parameters

Body

application/json

object

Example: "{\n \"filters\": {\n // fields\n }\n}"

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/TrainingCertificate/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"filters\": {\n        // fields\n    }\n}"),
});
const data = await response.json();

Public key Search

POSThttp://{{rc_private_host}}/registry-service/api/v1/PublicKey/search

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://{{rc_private_host}}/registry-service/api/v1/PublicKey/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {}
    }),
});
const data = await response.json();