Skip to main content

​
Overview

The eBRC API offers RESTful endpoints that let you securely and efficiently integrate with the platform and access its services.

​
Base URL

All API requests should be made to: 
https://ebrcapi.dev.eximfiles.com/api/v1

​
Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers: 
x-api-key: your_api_key_here
Keep your API key secure and never share it publicly. Each API key has specific access permissions and rate limits associated with it.

​
API Conventions

​
Request Format

  • Use HTTPS for all API requests
  • Send data in JSON format with Content-Type: application/json
  • Include authentication headers in all requests

​
Response Format

All responses are returned in JSON format with appropriate HTTP status codes:
  • 200 - Request successful
  • 201 - Resource created
  • 204 - Resource deleted
  • 400 - Bad request or invalid parameters
  • 401 - Authentication failed
  • 403 - Insufficient permissions
  • 404 - Resource not found
  • 429 - Rate limit exceeded
  • 500 - Internal server error
  • 422 - Issue related to DGFT config

​
Pagination

List endpoints support pagination using the following query parameters:
  • limit - Number of items per page
  • page - Page Number

​
Filtering

Many endpoints support filtering using query parameters. Refer to specific endpoint documentation for available filters.

​
Error Handling

Error responses follow a consistent format: 
{
  "code": "ERROR_CODE",
  "message": "Human readable error message"
}

​
Best Practices

  1. Implement proper error handling
  2. Cache responses when appropriate
  3. Use pagination for large data sets
  4. Follow API versioning guidelines
  5. Monitor your API usage

​
Need Help?

Contact Support

For help with the API, email us at [email protected]