Welcome to the NEXUS API. This REST API powers Smartstock's data services. It uses JSON for requests & responses and JWT for authentication. For ease of use, place this calls in a fetch command on your frontend js.
Authorization: Bearer <access_token> for terminal sessions.Authorization: "Bearer access_token" for frontend Javascript requests.In order to get the access and refresh code for JWT authentication, you require an api_key. It can be gotten in various ways
/api_key/
// Response
{
"api_key": "3e686ee..",
}
Also access the API key on your profile page.
api key
Now with the API key request JWT Tokens through the Token endpoints.
/token/
{
"api_key": "3e686ee..",
}
// Response
{
"access": "eyJhbGciOi...",
"refresh": "eyJ0eXAiOi..."
}
Success you can now call our Nexus API with the access token.
Various endpoints are only helpful with data appended to it, since they are bound to the shop you are requesting the API from. In order for the API endpoints to return valid json response you require to have already implimented these on your shop
With these actions you will be able get valid responses from the API call
/shop/employees/ ListReturns a json list of employess employed in your shop with their respective profile photo as a url, and their Smartstock username
fetch("https://../shop/employees/",
{headers: {Authorization: "Bearer access_token"}})"{
"employeeName": employee_name,
"profilePhoto": "https://..",
"employeeUserName": employee_username,
}/variable/checkVariable/ ListReturns a json list of variables created in your shop, comprising of its id, name and description only.
fetch("https://../variable/checkVariables/",
{headers: {Authorization: "Bearer access_token"}})"{
"id": variable_id,
"shopVariableName": "variable_name",
"shopVariableDescription": "description",
}/forms/getForms/ ListReturns a json list of forms created in your shop, comprising of its id, name and description only.
fetch("https://../variable/checkVariables/",
{headers: {Authorization: "Bearer access_token"}})"{
"id": form_id,
"formName": "form_name",
"formDescription": "form_description",
}/products/getProducts/ ListReturns a json list of products created in your shop, comprising of its id, signature, name, attributes and its sku number only.
fetch("https://../product/getProducts/",
{headers: {Authorization: "Bearer access_token"}})"{
"id": product_id,
"ssh": "eyJza3VfY2...",
"product_name": "product_name",
"product_attributes": {
"attribute_key": "attribute_value"..
},
"sku_code": "sku_code"
}/products/getProducts/?financial=orders ListReturns a json list of ORDER products created in your shop, comprising of its id, signature, name, attributes and its sku number only.
fetch("https://../product/getProducts/",
{headers: {Authorization: "Bearer access_token"}})"{
"id": product_id,
"ssh": "eyJza3VfY2...",
"product_name": "product_name",
"product_attributes": {
"attribute_key": "attribute_value"..
},
"sku_code": "sku_code"
}/products/getProducts/?financial=sales ListReturns an array of json list of SALE products created in your shop, comprising of its product_name, sku_code, unitCode, order_price, order_stock_amount, order_unit_name, order_sale_stock_amount, order_sale_unit_name, order_currency and sale_stock_amount only.
fetch("https://../product/getProducts/",
{headers: {Authorization: "Bearer access_token"}})"[{
"product_name": "product_name",
"sku_code": "7794-SMSTK-5D54F...",
"unitCode": "kg",
"order_price": "1000.0",
"order_stock_amount": 5,
"order_unit_name": "Bale",
"order_sale_stock_amount": 12,
"order_sale_unit_name": "Pack",
"order_currency": "KES",
"sale_stock_amount": 60,
},.....]