The /v4/test/key/ endpoint is a simple authentication check that lets you quickly test if your API key is working.
Notes on this endpoint:
- Authentication via header. To authenticate your API call, pass in your public API key with the X-Api-Key HTTP header.
HTTP Request
| Method | URL |
|---|---|
| GET | https://api.brokercarrier.com/v4/test/key |
Required Parameters
None.
Example Responses
Request: https://api.brokercarrier.com/v4/test/key
If your API key is valid and working, the response will be an object with the key "success" and a value of the current UNIX timestamp. If your API key is not valid or working, the response will be an error with the status code 400.
{
"success": 1712167311
}
{
"errors": [
"Invalid API request."
],
"status": 400
}