API Overview
Base URL: https://api.velocityafrica.net
Authentication
The API supports two authentication methods:
Bearer Token
Most endpoints require a Bearer token obtained from the Login endpoint.
Authorization: Bearer {{token}}
API Key
Some endpoints (e.g., Customer creation, Sales Order creation via API) use an API Key.
X-API-Key: {{apiKey}}
Collection Variables
| Variable | Description |
|---|---|
{{token}} | JWT token obtained from login |
{{apiKey}} | API key for machine-to-machine auth |
{{host}} | API host (e.g., http://localhost:6975) |
{{companyUid}} | Company UUID |
{{companyId}} | Company ID string |
{{companyIdString}} | Company ID string |
{{customerUid}} | Customer UUID |
{{authorizationUid}} | Authorization UUID |
{{authorizationId}} | Authorization ID |
{{customerAuthorizationId}} | Customer authorization ID |
{{supplierId}} | Supplier UUID |
{{itemCode}} | Item code |
{{qty}} | Quantity |
{{unitPrice}} | Unit price |
{{amount}} | Amount |
{{charge}} | Charge amount |
{{salesOrderId}} | Sales order UUID |
{{salesOrderTrace}} | Sales order trace ID |
{{transactionTrace}} | Transaction trace ID |
{{userId}} | User UUID |
{{paymentProcessor}} | Payment processor label |
{{debitCurrency}} | Debit currency code |
{{authType}} | Authorization type |
Common Headers
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | For requests with body |
Authorization | Bearer {{token}} | For authenticated endpoints |
X-API-Key | {{apiKey}} | For API key authenticated endpoints |