AgriChain API: Getting Started

Modified on Fri, 3 Jul at 5:46 PM

Introduction
This parent article provides a high-level introduction to the AgriChain REST API. It is the how to access/authorise and use AgriChain API.

What is the AgriChain API?

AgriChain exposes a RESTful HTTP API that allows authorised applications to read and write data in your AgriChain account programmatically. The API returns standard JSON responses and follows REST conventions (GET, POST, PUT, DELETE).

API Documentation References

The full interactive documentation is available at:

Swagger UI (try it live)

ReDoc (clean reference view)

Swagger UI lets you authenticate and execute real API calls directly from the browser. ReDoc provides a cleaner, read-only reference layout.

Requesting API Access

AgriChain's API offering can be enabled for your account by requesting access:. To request access:

  • Contact your AgriChain support.

Authentication

All API requests must be authenticated. User is required to send X- API key along with autherisation token in the headers.

Authorization: Token <your_api_token> 

X-API-Key: <X_API_Key>


Base URL

https://system-api.agrichain.com/


Rate Limiting & Fair Use

• 60 requests/minute

• 4,000 requests/day

Rate-limit headers: X-LimitRemaining-Minute, X-LimitRemaining-Day. On 429, respect Retry-After. 


Response Format

All responses are JSON. A typical successful response returns an HTTP 200 status with a JSON body. Error responses return appropriate 4xx or 5xx status codes with a JSON error description.

HTTP Status

Meaning

200 OK

Request succeeded

201 Created

Resource successfully created

400 Bad Request

Invalid parameters or malformed request

401 Unauthorized

Missing or invalid API token

403 Forbidden

Authenticated but not authorised for this resource

404 Not Found

Resource does not exist

429 Too Many Requests

Rate limit exceeded — wait before retrying



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article