🧬Public API

Overview

What is the Public API?

The Hesh Public API is designed to make it easy and fast for orders to get into the Hesh system and to the contractors. Transfer orders directly from an external system to Hesh with the necessary details and in the right quantity, change order information, or cancel them.

Advantages of using the API

Using the API allows Hesh to automate your production processes by integrating with other systems with flexible settings.

Target audience

• Developers

• Integrators

• Customers

The first steps

Authentication

The API is accessed through the API Key. To get the key, contact your Success Manager.

Basic URL and environments

Production environment: https://api.hesh.app/api/v1/public

Data formats

• JSON

HTTP response codes

This API uses the following error codes:

• 400 Bad Request — The request was malformed or missing the required parameters.

• 401 Unauthorized — The API key provided was invalid or missing.

• 404 Not Found — The requested resource was not found.

• 500 Internal Server Error — An unexpected error occurred on the server.

API method dictionary

Method categories:

1. Clients
2. Orders
3. Rewards
4. Users

In each of the following paragraphs, it will be explained in detail about all the methods through which data can be transferred to the system.

FAQ

Where does the synchronization go from here to HESH?

From an external system to Hesh.

What data comes from the external system to HESH?

An order is sent from the external system. In the body of the request, there is a quantity field, and these will be the production items that are already being launched for execution.

For example, you send order 123-S for the production of 5 laptops.

More about order creation here.

Technical support

Contact your Success manager for providing needed information.