Versions Compared

Version Old Version 1 New Version Current
Changes made by

Que Nguyen

allen li

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API is designed to return a file information by file Id returns after successfully uploading file via [POST]

Status
colourGreen
titlePOST
/public/v2/documents/devices

Table of Contents

Table of Contents
stylenone

Changelogs

Version

Date

Changes by

Description of change

V1.0.0

Que Nguyen

  • Initiated document

File Source

Name text

Uploaded File name

Path text

Upload File Path URL location

Code Block
languagejson
{
  "Name": "owner-declaration-file-220524-083428.pdf",
  "Path": "https://file.rehash.redex.eco/40b4d151-3385-451f-81cb-2fb45bcbb753/1716550050868_owner-declaration-file-220524-083428.pdf"
}

API Definitions

Status
colourGreen
titleGET
/public/v2/documents/devices/{fileId}

Request

Headers

Content-Type

multipart/form-data

Authorization

Bearer {{access_token}}

Query Parameters

ValidationCode (optional) text

验证码 （可选） 文本

Validation code returned one time after uploading successfully on API upload

Important Note: for old uploaded file, please leave this parameter as empty.

Example: ?ValidationCode=

Code Block
curl -X 'GET' \
  'https://uat-api.redex.eco/public/v2/documents/devices/9B8CCC2D-3C11-4579-C444-08DC7BE48053?ValidationCode=321312' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {{access_token}}'

Response

Response Body

Data object - file resource

Object of File Resource

Data.Name text

Uploaded File name

Data.Path text

Upload File Path URL location

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta null object

Return null object

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info

200 Success

Code Block
languagejson
{
  "Data": {
    "Name": "owner-declaration-file-220524-083428.pdf",
    "Path": "https://file.rehash.redex.eco/40b4d151-3385-451f-81cb-2fb45bcbb753/1716550050868_owner-declaration-file-220524-083428.pdf"
  },
  "Meta": null,
  "Errors": null,
  "StatusCode": 200,
  "Message": "Success"
}

Warning

404 Not Found

Code Block
languagejson
{
  "Data": null,
  "Meta": null,
  "Errors": null,
  "StatusCode": 404,
  "Message": "The File ID 128ccc2d-3c11-4579-c444-08dc7be48053 does not exist."
}

Warning

401 Unauthorized

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 401,
  "Errors": [],
  "Meta": null,
  "Message": "Unauthorized"
}

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

  • Rate Limit: 3000 requests per 5 minute(s)

  • Renewal Period: 300 second(s)

  • Key: IP Address

  • Increment Condition: Any Request

Operation Policy

  • Rate Limit: 60 requests per 1 minute(s)

  • Renewal Period: 60 second(s)

  • Key: accound-id business account Id.

  • Increment Condition: Any Request

Rate Limit Details

  1. Rate Limit by Key:

    1. Key: This ensures that rate limits are applied uniquely for each business account id.

    2. Request Limit: Each key is allowed to make up to 60 requests per minute.

    3. Reset Interval: The limit resets every 60 seconds.

  2. Response Headers:

    1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

Example Response When Rate Limit is Exceeded

Code Block
languagejson
HTTP/1.1 429 Too Many Requests
Retry-After: 60
Content-Type: application/json

{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}