Make your first API request

BEFORE YOU START

Confirm your prerequisites #

• A Velosity tenant where you can create an API key.
• A sandbox or demo tenant for development.
• A server-side terminal with cURL installed. Do not run this request from browser code.

01 / API KEY

Create an API key #

In the Velosity Dashboard, open Developers, create an API key for your integration, and store it in your server-side secret store. Treat an API key like a password: never place it in a URL, browser storage, source code, or client-side application.

02 / ENVIRONMENT

Choose your environment #

Use the sandbox or demo base URL while developing, then change only the base URL and credentials when moving to production. Keep credentials out of copied links and request logs.

03 / FIRST REQUEST

Retrieve customers #

Make your first authenticated request from a server or trusted local tool. Replace YOUR_API_KEY before running it.

curl --request GET "https://api.velosity.one/v1/customers" \
  --header "X-APIKEY: YOUR_API_KEY"

04 / EXPECTED RESULT

Verify the response #

A successful request returns 200 OK and a JSON customer collection. Field availability depends on your tenant and the selected API version.

{
  "items": [
    { "id": "customer_demo_001", "name": "Example customer" }
  ]
}

05 / TROUBLESHOOT

Resolve common issues #

401 or 403

Confirm the API key is active, belongs to this tenant, and is sent as the X-APIKEY header.

404

Check that the base URL and API version match the environment you selected.

Network error

Confirm the request originates from a system permitted to reach the selected environment, then retry with the same correlation ID in your logs.

06 / CLEAN UP

Clean up credentials #

Remove the test key from your terminal history and local environment after testing. Revoke keys that are no longer needed, including keys used for a demonstration or temporary integration.

07 / KEEP BUILDING

Learn the integration flow #

Use the API reference for endpoint fields, response schemas, pagination, and errors. Use the guides for customer sync, quote lifecycle, PDF generation, tenant setup, and ERP integration behavior.