Authentication

How to get connected

API Access

To connect to REST API, you will need a Personal API Key.

You can request a Personal API Key by sending an email to the Menuflow team at [e-mail].

API Key

Before making any requests to a protected resource, you'll need to make sure you have a API Key. You will need to include this in your authorisation header on each request.

API Keys do not refresh. Make sure you handle and store your Key securely. If it becomes compromised, make sure you revoke access to it in your Menuflow portal.

Using your API Key in requests

Whenever the user wants to access a protected route or resource, the user agent should send their api-key in the header of the request using the x-api-key schema. The content of the header should look like the following:

cURL

curl --header 'x-api-key: YOUR-API-KEY' \

PHP

<?php
$client = new Client();
$headers = [
  'x-api-key' => 'YOUR-API-KEY',
];

Authentication failure

If you are not authorised and you attempt to make a request to a protected endpoint, the API will return JSON with status_code 401 authentication failure.

{
    "status_code": 401,
    "message": "authentication failed"
}