This guide explains how to create a quick access link using Quatrix API. 

  1. Log in to the account using GET /session/login
  2. Get home_id from GET /profile/
  3. Retrieve a link for uploading a file using POST /upload/link with the following parameters:

    NameTypeDefault ValueDescription

    name*

    string-

    file name

    parent_id*


    string-

    the ID of the folder where you would like to upload your file.

    parent_id = home_id  from the previous call

    resolve


    booleantrue

    if there is an existing file with the same name, the new file will not be overwritten and will have an extension in its name (e.g.: the existing file - test.pgp and the new file - test(1).pgp )

    if the value is false and the file with the same name already exists, you'll get an error: TypeError: Failed to fetch

    file_size

    number-file sizes are measured in bytes (B)

    * required parameters 

  4. Get the upload_key from the previous call and make POST /upload/chunked/{id}.
  5. Complete the chunked upload of the file using GET /upload/finalize/{id}.
  6. Create a quick link using POST /quicklink/create with the following parameters: 

    Name

    Type

    Default Value

    Description

    subject

    string

    ' '

    the share subject

    files*


    list of strings

    -

    the ID of the file you upload data to

    from the response GET: /upload/finalize

    pin

    string

    -

    base64 format

    https://www.base64encode.org/

    notify

    booleanTrueTrue or False

    *required parameters


Example Request URL

 HTTP POST      https://api-test.quatrix.it/api/1.0/quicklink/create

Request Payload

{
  "subject": "quick link test",
  "files": [
    "435766b3-8121-4685-8126-3edecde29a39"
  ],
   "pin": "MTIzNDU="
}

 

Response Body

{
  "files": [
    "435766b3-8121-4685-8126-3edecde29a39"
  ],
  "activates": 1536842951,
  "id": "14a522d0-5a76-4ed6-a208-09382450148e",
  "expires": 1537447751
}