Quick start
Make your first successful Sandbox request in four steps.
Protect your Voyced access from the first test
Your API credentials can access customer information and the functions allowed for that key. Treat the API secret like a password. Store it only in protected server-side settings or a trusted secret store.
- Never put an API key, API secret or bearer token in public code, browser JavaScript, screenshots, URLs or support messages.
- Keep Sandbox and Live credentials separate. Give each integration only the permissions it needs.
- Rotate the secret and disable the old key at once when exposure is suspected.
Before you begin
You need a Sandbox API key and API secret supplied by Voyced. Use the Sandbox URL throughout this guide. Do not use the Live URL or Live credentials until Voyced confirms that Live access is enabled.
1
Request a temporary bearer token
Send your Sandbox API key and secret to the Sandbox token endpoint.
cURL
curl --request POST \
--url 'https://sandbox.voycedconnect.eu/v1/auth/token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"api_key": "YOUR_SANDBOX_API_KEY",
"api_secret": "YOUR_SANDBOX_API_SECRET"
}'2
Copy the bearer token
Read data.access_token from the response. The token is temporary. Request a new one when it expires.
Example response
{
"success": true,
"request_id": "req_example1234567890",
"data": {
"access_token": "TEMPORARY_BEARER_TOKEN",
"token_type": "Bearer",
"expires_in": 3600,
"expires_at": "2026-07-21T11:00:00+00:00"
}
}3
Test the customer connection
This read-only request confirms that the key can reach the customer information assigned to it.
cURL
curl --request GET \
--url 'https://sandbox.voycedconnect.eu/v1/test' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN'4
Read the available functions
Use the capabilities endpoint before building a workflow. Permissions can differ between keys and environments.
cURL
curl --request GET \
--url 'https://sandbox.voycedconnect.eu/v1/capabilities' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN'No assembly needed
Open the PHP testPrefer one complete PHP test?
Download one file, add only your Sandbox API key and secret, then run the full read-only test.