Skip to main content

Get product

Get All Product​

Returns a paginated list of products for eLimu, including the available API endpoints and the core parameters used in product retrieval.

GET /edtech/v1/products
const webRequest = fetch(
  "BASE_URL/edtech/v1/products?page=1&take=50&orderBy=DESC",
  {
    method: "GET",
    headers: {
      "x-client-api-key": "your-api-key",
    },
  }
).then((response) => response.json());

Response 200​

RESPONSE

{
    "statusCode": 200,
    "description": "Successful: got product list",
    "data": {
        "total": 100,
        "data": [
            {
                "id": "product id",
                "name": "Name of game",
                "description": "An ATM kind of game",
                "previewUrl": "https://previewurl.com",
                "mascotName": "elbert",
                "imgUrl": "https://imgUrl",
                "minAge": 5,
                "maxAge": 10,
                "minGrade": 1,
                "maxGrade": 6,
                "category": "MATH",
                "miniSrcUrl": "",
                "logoImgUrl": "https://logoUrl.png",
                "rank": 110,
                "publishVas": false,
                "eligiblePlans": [
                    "Free",
                    "Basic"
                ]
            }

        ]
    }
}

Get A Product​

Returns the details of the product which its id is passed in the query parameter,

GET /edtech/v1/products/:id
const webRequest = fetch(
  "BASE_URL/edtech/v1/products/:id",
  {
    method: "GET",
    headers: {
      "x-client-api-key": "your-api-key",
    },
  }
).then((response) => response.json());

Response 200​

Content type: application/json

RESPONSE

{
    "statusCode": 200,
    "description": "Successful: got product list",
    "data": {
                "id": "product id",
                "name": "Name of game",
                "description": "An ATM kind of game",
                "previewUrl": "https://previewurl.com",
                "mascotName": "elbert",
                "imgUrl": "https://imgUrl",
                "minAge": 5,
                "maxAge": 10,
                "minGrade": 1,
                "maxGrade": 6,
                "category": "MATH",
                "miniSrcUrl": "",
                "logoImgUrl": "https://logoUrl.png",
                "rank": 110,
                "publishVas": false,
                "eligiblePlans": [
                    "Free",
                    "Basic"
                ]
    }
}

Get A Product srcUrl​

Returns the details of the product which its id is passed in the query parameter,

GET /edtech/v1/products/:id/play
const webRequest = fetch(
  "BASE_URL/edtech/v1/products/:id/play",
  {
    method: "GET",
    headers: {
      "x-client-api-key": "your-api-key",
    },
  }
).then((response) => response.json());

Response 200​

Content type: application/json

RESPONSE

{
    "statusCode": 200,
    "description": "Successful: got product url and data",
    "data": {
        "srcUrl": "",
        "chunks": {
            "": ""
        }
    }
}