Glossary

Plain-language meanings for the terms used in this documentation.

API key

A public identifier for an integration. It works only with its matching API secret.

API secret

A private long-term credential used only to request a bearer token.

Bearer token

A temporary credential sent in the Authorization header for API requests.

Base URL

The environment address placed before an endpoint path.

Endpoint

A specific API path and method, such as GET /v1/customer.

Environment

Sandbox or Live. Each uses a different base URL and separate credentials.

Permission

An action the API key is allowed to perform, such as numbers.read.

Request ID

A unique reference returned by Voyced for a request. Include it when asking for support.

Sandbox

The environment used to build and test an integration before Live access.

Live

The production environment used after testing and Voyced approval.