Skip to main content

API Reference

For complete, interactive API documentation with request/response schemas, authentication details, and a testing interface, please visit our Scalar API documentation.

Access the API Reference​

The full API reference is available at the following URL based on your environment:

Staging Environment​

https://qa.sender.api.barid.ae/docs

Production​

https://sender.api.barid.ae/docs

What You'll Find​

The interactive API documentation includes:

Complete Endpoint Reference​

  • All available API endpoints
  • HTTP methods and URL paths
  • Required and optional parameters
  • Request body schemas
  • Response formats and status codes

Authentication Guide​

  • Session generation examples
  • Authentication header formats
  • Token refresh procedures

Interactive Testing​

  • Test API calls directly from the browser
  • Pre-filled example requests
  • Real-time response preview
  • cURL command generation

Code Examples​

  • Request examples in multiple languages
  • Response examples with sample data
  • Error handling patterns
  • Best practices

Data Models​

  • Complete schema definitions
  • Field descriptions and types
  • Validation rules
  • Example payloads

OpenAPI Specification​

Download the raw OpenAPI specification for code generation:

Production​

https://sender.api.barid.ae/openapi/v1.json

Use this specification with tools like:

  • Swagger Codegen
  • OpenAPI Generator
  • Postman
  • Insomnia

Getting Started with the API​

Support Resources​

API Versions​

The Barid Sender API uses version 1 (v1). All endpoints are prefixed with /api/v1/.

Future API versions will be announced with:

  • Advance notice period
  • Migration guides
  • Deprecation timelines
  • Backward compatibility details

Support​

For API-related questions and issues: