Generate Access Endpoint

GET Management/V1/Queue/GenerateAccess/[JobKey]

Url Parameters

Parameter	Description
JobKey	The unique identifier of the submitted file for appending. If submitted via SFTP or via website upload, this is automatically generated for you. If submitted via the Submit File endpoint, this is the value supplied in the "request_id" parameter. This value is also available as part of the returned data from the View Queue endpoint.

Authentication
Authentication to this endpoint is performed by supplying your api key value in the "Authorization" HTTP header of the request.

Response (Success) HTTP 200

{
  "AccessUri": "https://FULLY QUALIFED UNIQUE URL TO ACCESS YOUR APPENDED FILE",
  "Expiration": "2024-10-25T23:43:42.580825Z"
}

Understanding the Access payload

Element	Description
AccessUri	The unique fully qualified path to use to download your indicated file.
Expiration	The date and time (in ISO 8601 format) until the AccessUri becomes invalid (Typically 10 minutes). After this expiration another access url can be generated.

📘
Important
It is your responsibility to properly secure, store, and use the generated access uri
which should not be exposed to unauthorized parties. Any party with an unexpired value
can use it to download your appended file.

Responses (Failure)

HTTP Status Code	Description
403 Unauthorized	Your api key was not found or you are not a current subscriber.
404 NotFound	Your indicated file could not be found for your account or is no longer available.
500 ServerError	We encountered and error while processing your request. Please try again.

📘Important

📘
Important