Developers
API Access
The Velosity API documentation is available here. To access the API, add X-APIKEY to the request header. You can generate an ApiKey from your profile in Velosity (top right icon, Profile, scroll down to API section)
Curl Example:
curl -X GET "https://api.velosity.app/v1/customers" -H "accept */*" -H "X-APIKEY:_yourapikeyhere_"
The first call to the API should use the X-APIKEY, which will return two cookies (contact SUPPORT for details). These cookies should be used on all subsequent calls to prevent rate limiting (necessary to prevent abusive unauthenticated calls). Too many calls will return a 429 error (Too Many Requests).
Webhooks
The API supports integration with other appilcations via Webhooks. You can define webhooks for various entities, each of which have various events. The payload sent to your application end points (POST) will be the entity itself (Sales Quote, Sales Order, etc).
PDF Generation
Velosity uses Word templates that are converted to PDF in various places:
- Sales Quote
- Sales Order
- Production Order
- Production Order Traveler
The template ID (DocumentID) must be passed to the API endpoint to inform it which template to use. Click here for more details.