API Documentation - Transipal

Getting Started

The Transipal API provides programmatic access to your warehouse management system. Access missions, tasks, and inventory data through a RESTful interface with JSON responses.

Important

All API requests must be made from a warehouse-specific subdomain (e.g., boudry.transipal.wip/api).

Authentication

Authenticate using your credentials to receive a JWT token. This token must be included in all subsequent requests.

Endpoint

POST

Request Body

{
  "email": "user@example.com",
  "password": "your_password"
}

Response

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "warehouse": {
    "id": 1,
    "name": "Boudry",
    "subdomain": "boudry"
  }
}

Using the Token

Include the JWT token in the Authorization header of all API requests.

Authorization Header

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGc...

Example Request

curl -X GET "https://boudry.transipal.wip/api/missions" \
  -H "Authorization: Bearer YOUR_TOKEN"

Tokens expire after 1 hour. Re-authenticate to obtain a new token.

Interactive API Documentation

Try API requests directly from your browser with Swagger UI

View Interactive Documentation