Document Management

Rialto's API uses AWS S3 Presigned URLs to upload and download documents to be added to the requests.

Below are listed the steps necessary to complete API calls with documents.

Get Presigned urls

When an API user needs to join a document to a request (e.g. join a document for a trade request, create a managed Client Account etc.), they need to first upload the documents before making the request.

For that matter, users need to call the POST /uploads/request-batch-upload route with a list of filenames joined in the request body. This route is available with both Client and Manager APIs.

The request will return a list of AWS S3 Presigned URLs, used to upload the documents. The user then needs to make a PUT request to the URL with a document path as parameter.

For example with the curl command line interface : curl -X PUT -T <path to my local file> <Presigned URL>

Files will be put in a temporary storage folder while waiting to be included into an API request.

Use uploaded files in API requests

Files uploaded via Presigned URLs are placed in a temporary storage; this folder is emptied every 24 hours. Users can get a list of the currently available files by calling the route GET /uploads .

Files that were uploaded can then be referenced by filename to be included in API requests.

When a file is successfully used as a parameter in an API call, the file is then moved to a permanent storage folder. The name of the file is also modified to prevent conflicts.

For example, when file1.jpg is used, a name such as 7111bfb8-d6d3-4930-a6d0-eaa68a1c431a_file1.jpg might be generated. This new filename can be used to download the file.

Download files

Downloading files is similar to uploading. API users need to request Presigned URLs with the route POST /documents/request-batch-download and joining a list of filenames (including their uuid addition) in parameter.

The request will return a Presigned URL to be used to download the document.

For example with the curl command line interface : curl -o <path to my destination> <Presigned URL>

Please read this guide on the AWS website for more information. Please also refer to the Client API reference and the Manager API reference for more details about the document management routes.