Overview#
Authentication is required for all requests to the FlowVoice public API. Each request must include a valid API key in the HTTP headers to ensure secure access.Obtaining an API Key#
To access the API, an API key must be generated from the company settings menu within the FlowVoice dashboard. Each company has its own unique API key that should be kept confidential.Authentication Method#
The FlowVoice API uses API key authentication via the Authorization: Bearer header. Each request must include this header with a valid API key.Example Request#
Example Using cURL#
curl -X GET "https://api.getflowvoice.com/public/endpoint" \
-H "Authorization: Bearer your-api-key-here"
Example Using JavaScript (Fetch API)#
Security Considerations#
Keep your API key secure: Never share your API key publicly or expose it in client-side code.
Rotate keys periodically: To enhance security, consider rotating your API keys regularly.
Restrict usage: If possible, configure API key restrictions to limit access to specific endpoints or IP addresses.
Error Handling#
If authentication fails, the API will return an error response with the appropriate status code.Common Errors#
| Status Code | Meaning | Description |
|---|
| 401 | Unauthorized | API key is missing or invalid. |
| 403 | Forbidden | API key is valid but does not have the necessary permissions. |
Example Error Response#
{
"error": "Unauthorized",
"message": "Invalid API key."
}
Next Steps#
Once authenticated, you can start using the API to interact with FlowVoice services. Check the full API documentation for available endpoints and request parameters.Modified at 2025-06-05 13:08:51
