Skip to main content

Authentication

Request Headers​

API Key​

Byte Kitchen uses Basic Authentication. The request Authorization header should include the API key with the prefix 'Bearer`.

const headers = {
    "Authorization": `Bearer ${your_api_key}`
}

Content Type​

All API requests or responses require the content-type header to be set to application/json.

const headers = {
    "Authorization": `Bearer ${your_api_key}`, 
    "Content-Type": "application/json"
}

Root URL​

All requests should be made to the the production enviroment, (*a sandbox enviroment will be made availble in the future).

Example Request​

import axios from "axios"; 

const headers = {
    "Authorization": `Bearer ${your_api_key}`,
    "Content-Type": "application/json"
};

const rootUrl = "https://us-central1-checklist-admin-d0013.cloudfunctions.net/api/v1";

const requestLocations = axios(rootUrl+"/locations/list", { headers });

Response Codes​

Status CodeName/ResponseDescription
200/201✅ SuccessEverything worked as expected
400❌ Bad requestThe request didn’t work, often because a required parameter is missing or the content-type hasn’t been set e.g. an incorrect JSON request
401⚠️ UnauthorizedAuthorization token is invalid, or being used in the wrong environment
403🛑 ForbiddenRequesting user lacks permission to perform
404⛔️ Not foundResource not available on requested endpoint
429❗️Too many requestsRate limiter kicked in, scale back request frequency
5xx🛑 Server errorSomething went wrong on our end - there will be a TraceID in the response you can send us to help figure out the issue!

Obtaining an API key​

To get started with the Byte Kitchen API you will need a valid API key. You can get your API key by contacting us at support@bytekitchen.io.