API Reference

Get all Plans

This Endpoint is used to fetch plans.
Note: The filter parameter are not required to just to fetch the base on options.

curl --location --request GET 'https://sandbox.nucleusis.io/api/plans' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{API-KEY}}'

GET /api/plans HTTP/1.1
Host: nucleusis-retail-api.herokuapp.com
Accept: application/json
Authorization: Bearer NUC-1BsOLIJwQyLrqkICdZIO-X

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer NUC-1BsOLIJwQyLrqkICdZIO-X");

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://nucleusis-retail-api.herokuapp.com/api/plans", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
ParametersTYPEComments
category ELDERLY, FAMILY, INDIVIDUAL, SMEThis is the category parameter
location(string)Location where plan can be accessed
name(string)Name of the plan
insurer(int)The ID of the insurer

👍

HTTP 200 (OK)

{
    "msg": "successful",
    "status": true,
    "data": [
        {
            "id": 1,
            "planName": "LIFE CORAL PLAN (Individual)",
            "planAmount": {
                "amount": "20500.00",
                "currency": "NGN"
            },
            "planTenure": "12months ",
            "planStatus": true,
            "planCategory": "INDIVIDUAL",
            "planBenefits": {
                "general_consulation": true,
                "glasses": true,
                "specialist_consultation": true,
                "paedetrics": true,
                "admission": true,
                "fertility_care": false,
                "mental_care": false,
                "antenatal_care": false,
                "optical_care": true,
                "dental_care": true
            },
            "locations": [...],
            "providers": [...]
        },
   ]
}

❗️

HTTP 403 (FORBIBBEN)

{
    "msg": "API key is invalid, Please contact support!",
    "status": false
}