The Data Integrity OmniSeal™ API, built on a REST architecture, is designed for ease of use and predictability. Here's an overview of how it operates:
Each API endpoint corresponds to a specific resource or a collection of resources, making the URLs intuitive and easy to understand. For example, register a user uses a URL like:
https://api.purecipher.com/register
The API accepts request bodies in form-encoded format. This means when you need to send data to the server (like creating or updating a resource), you'll encode this data as form fields.
The API uses standard HTTP verbs to define what action is being taken:
Code | Status | Description |
---|---|---|
200 | OK | The request was successful. |
201 | Created | The request was successful, and a resource was created as a result. |
202 | Accepted | The request has been received but not yet acted upon. |
204 | No Content | The request was successful, but there is no content to send in the response. |
400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 | Unauthorized | No valid API key provided. |
403 | Forbidden | The client does not have access rights to the content. |
404 | Not Found | The requested resource doesn't exist. |
405 | Method Not Allowed | The request method is not supported for the requested resource. |
409 | Conflict | There is a conflict with the current state of the target resource. |
415 | Unsupported Media Type | The payload format is in an unsupported format. |
429 | Too Many Requests | The user has sent too many requests in a given amount of time ("rate limiting"). |
500 | Internal Server Error | An error occurred on the server. |
502 | Bad Gateway | The server, while acting as a gateway, received an invalid response from the upstream server. |
503 | Service Unavailable | The server is overloaded or under maintenance. |
504 | Gateway Timeout | The server, while acting as a gateway, did not get a timely response from the upstream server. |