Buycycle API

This is a RESTful API service endpoint. Direct browser access is not intended for this application.

Note: This API requires authentication. All requests must include a valid JWT token.

Available Endpoints

Authentication

POST /api/login - Authenticate and receive a token

Required body: { "username": "your_username", "password": "your_password" }

Bookings

GET /api/bookings - Retrieve paid out bookings

Required header: Authorization: Bearer YOUR_TOKEN

Shipment Details

GET /api/shipments/:booking_id - Retrieve shipment details for a specific booking

Parameters: booking_id - The ID of the booking

Required header: Authorization: Bearer YOUR_TOKEN

Comment Statuses

GET /api/comment-statuses - Retrieve all comment statuses

Required header: Authorization: Bearer YOUR_TOKEN

Departments

GET /api/departments - Retrieve all departments

Required header: Authorization: Bearer YOUR_TOKEN

Users

GET /api/users - Retrieve all users

Required header: Authorization: Bearer YOUR_TOKEN

Booking Details

GET /api/booking-details/:booking_id - Retrieve detailed information for a specific booking

GET /api/booking-details-large/:booking_id - Retrieve comprehensive shipment and tracking information for a specific booking

Parameters: booking_id - The ID of the booking

Required header: Authorization: Bearer YOUR_TOKEN

Rate Limiting

This API is limited to 1000 requests per minute per IP address. Exceeding this limit will result in a 429 status code.

How to Use

This API is designed to be accessed programmatically. Use tools like:

Example Request

curl -X GET http://example.com/api/bookings \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

For more information, please contact the API administrator.