Overview

The Stellar Menus API requires authentication for accessing various resources and functionalities. In addition, our platform supports webhook interactions to receive messages from partner applications.

Authentication

To authenticate with the Stellar Menus API, every request must include an Authorization header. The value should be set to the API key provided to you by Stellar Menus.

Header format

Authorization: <Your-API-Key>

Replace <Your-API-Key> with the API key you've received from Stellar Menus.

Unauthorized Responses

If authentication fails or an invalid API key is used, you'll receive a message similar to this:

{ 
   "message": "Unauthorized: Token missing"
}

Testing Authentication

To verify your API key:

Send a GET request to /webhook/v1.
A successful authentication will return:

{ 
   "message": "The APIs are up, running and available"
}

If you haven't received an API key or encounter any authentication issues, please contact Stellar Menus support.

Sending Messages to the Webhook

Our platform's Webhook listener is designed to receive vital messages from our partner applications.

Request

Format:	JSON
Endpoint:	/v1/webhook
Method:	POST
Headers:	Authorization: <Your-API-Key>

Required Fields

partner_id: A unique ID for the partner application. This ID, provided by Stellar Menus, helps determine the source of the incoming message.
message_code: Specifies the type or nature of the message for proper processing.
message_body: Contains the main content of the message, which can range from a simple string to a structured object.

Both the message_codes and message_bodies should be predefined in coordination between Stellar Menus and the partner.

Response

Depending on the validity of the sent data, the webhook will return a response with either a 200 (OK) or 400 (Bad Request) status code.

Example Request

{ 
   "partner_id": "1a2b3c4d", 
   "message_code": "a1254", 
   "message_body": "63250dafda6e3c02447e4296" 
}

Expected Response

{ 
   "success": true, "message": 
   "Webhook processed successfully" 
}