🧬Public API

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

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:

  • 200 OK - The request was successful.

  • 201 Created — The resource was successfully created.

  • 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.

  • 429 Too many requests — The rate limit is reached.

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

Rate Limiting and Fair Usage Policy

To ensure fair and reliable access for all integrators, the Public API enforces multiple throttling layers. These limits protect the stability of the platform while allowing consistent, high-volume integration.

Requests are tracked and rate-limited within the following time windows:

Window
Limit
Description

Burst

15 requests / second

Handles short, high-frequency spikes without penalizing normal workloads

Short

300 requests / minute

Governs sustained request rates within a one-minute window

Medium

4,000 requests / hour

Ensures fair long-term throughput across all tenants

If these thresholds are exceeded, the API responds with HTTP 429 Too Many Requests and temporarily blocks further requests until the limit window resets.

⚠️ Important: The limits described below represent global rate limiters applied across most endpoints. However, certain resource-intensive or high-complexity endpoints may have stricter or separate throttling rules to protect overall system performance. Developers integrating with such endpoints should review each operation’s specific documentation for its applicable limits.

Response Headers Reference

Header
Description

X-RateLimit-Limit

Maximum number of allowed requests during the current window

X-RateLimit-Remaining

Remaining number of requests before throttling occurs

X-RateLimit-Reset

Number of seconds until the rate limit window resets

Integration Recommendations

  • Implement exponential backoff when receiving HTTP 429.

  • Avoid tight retry loops - continued requests during a block window will extend the delay period.

  • For continuous synchronization or high-frequency data exchange, consider batching requests or scheduling them across intervals.

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.

PreviousAnalyticsNextUsers

Last updated