Post-process your API Request
This endpoint is a follow up to the /pre-process endpoint
This endpoint only works in conjunction to the Pre-processing endpoint POST /parse/pre-processing. Without it,
the necessary information for this endpoint won’t be found.
This endpoint is mainly to complete the idempotency system and a complete logging system! If you don’t care about these things, and want less complexity in your system, feel free to not use it.
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.
If you have idempotency configured on the platform, but isn’t implemented correctly here, idempotency will not work as expected.
This endpoint ID is taken from the pre-processing endpoint and passed in here.
This request ID is taken from the pre-processing endpoint and passed in here.
This request body comes from expected return from your services. If the same idempotency key is sent, then we’ll automatically return back this response body.
This is the status code your API will respond with for the given request. Must
have a 2xx status code.
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.
You can also find this apiKey returned by our pre-process endpoint.
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.
It will be returned to you by our pre-process endpoint for consistency purposes.
Response
The response of this API request can vary to return back either a descriptive error message for you (not your user) to use for debugging, or information on the API request and the Idempotency Key provided (to indicate a successful operation).
If idempotencyInfo does not exist for a given endpoint (the endpoint may not have it configured), then we will return back the request and idempotency key information.
This field specifies when this key can be reused and executed as if it was the key’s first attempt.