Pre-process your API Request
This endpoint should be put in the pre-processing middleware: Authentication, Access Control, Dynamic Rate Limiting, Idempotency, Versioning, Sandbox, and more.
This endpoint is the only endpoint necessary in your public API unless you’d like additional logging and Idempotency. This endpoint would be best to be called in the middleware of your public API, before any of your endpoints are touched (hence the term preprocessing).
Request
An API key is a token that you provide when making API calls.
An Application ID that finds the application you are working with. This Application ID can be found on the Integral platform through the dashboard or Application’s page.
Body Parameters
This information allows us to process the request, but it relies on setting up an application fully before being able to properly use it. For a “red carpet” set up on your application, contact shrey@integralapi.co, and we’d love to get you started without any hassle on your end.
This API key is the key passed in by your API’s user. This is crucial for us to parse out your application’s user
IP address of the incoming request so we can rate limit on top of it.
HTTP method of the incoming request
Allowed values: GET, POST, PUT, DELETE, PATCH, OPTIONS, CONNECT,
TRACE
The request body from the incoming request from input validation. Null if
request method is a GET
Headers from the incoming request
Path (with all variables inside), from the request to match endpoints created on the Integral platform.
The query parameters (parameters in the URL that come after the base URL and
?) of a request object. Pass in an empty object if it doesn’t exist.
A single level key-value JSON object that can be used to store custom data for the API request; keys and values must be strings
This key is a user generated unique identifier to map to a request. This allows requests to be safely retry requests without the risk of duplicating operations.
GET, PUT, and DELETE are generally safe to retry (according to standard REST practices). For POST and PATCH requests,
is recommended to send and store the idempotencyKey in their system.
A value passed in for the version string of a given request.
This is not to be confused with the version field returned on the request object in the response. This version is the raw string passed in from the user.
Response
The response of this API request can vary to return back matched sandbox data, a graceful and informative error, or information for you to know which user is accessing your API and some general information about the incoming request.
Response Fields
General information you can utilize to build your integration
This field indicates the status code for you to return back to your
application’s user! >= 200 and 504 <=
This field will return back null, if the response body’s status code is 200 – thus it is not a required field