Disclaimer
The information provided in this document is provided 'as is' without warranty of any kind. Vital4 disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. In no event shall Vital4 be liable for any damages whatsoever including direct, indirect, incidental, consequential, loss of business profits or special damages, even if Vital4 or its suppliers have been advised of the possibility of such damages.
VITAL4, LLC - www.vital4.net
General information
Standards
- All data is sent and received in JSON format in
UTF-8encoding - All timestamps are UTC and in ISO 8601 format
YYYY-MM-DDTHH:MM:SS
Troubleshooting
Here is a list of the most common critical errors that our API will return:
| Code | Status | Description |
|---|---|---|
400 |
Bad Request |
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request value, ...) |
401 |
Unauthorized |
The client must authenticate itself to get the requested response. |
403 |
Forbidden |
The server understands the request but refuses to authorize it. |
429 |
Too Many Requests |
The user has sent too many requests within a given amount of time ("rate limiting"). |
500 |
Internal Server Error |
The server has encountered a situation it does not know how to handle. It is advised to contact Vital4 support. |
We recommend logging the error response returned from the API so it can be used for efficient problem resolution.
Support
In case of unexpected behavior or other support issues, please reach out:
- Submit a new ticket on our support portal
- Send an email to customersupport@vital4.net
Changelog
| Date | Changes |
|---|---|
| May 2023 | Initial release of API v4 with token authentication, Vital4Trace and webhook endpoints. |
Usage
You can use the above authentication form if you want to send authenticated requests directly from this website.
To generate a token, use the login credentials provided by Vital4 and trigger a request using the Create a token operation.
Once you have received a successful response, copy and paste the token into the api-token form field prefixed by Bearer.
For more general information about tokens, please visit the Token page.