Working with Large Cases

Our API enforces a maximum payload size limit of 1722 signatures. To efficiently handle large cases requiring aggregation, we recommend adopting our three-step workflow.

This workflow consists of three steps:

1. Initiate an aggregation task

2. Upload task file

3. Notify PQScale to start processing the task

Initiate an aggregation task

Begin by initiating a task specifically for aggregation purposes. This step sets the foundation for the subsequent processes.

POST /v1/pqscale/aggsign/task

Headers

Name	Type	Description
Authorization*	String	Your API Key

Request Body

Name	Type	Description
callback	JSON	Refer to Callback Model

POST /v1/pqscale/aggsign/task

Headers

Name	Type	Description
Authorization*	String	lY0A8W2omwjY

Request Body

Name	Type	Description
callback	JSON	48xjy6A4lSyr

Response example

200 OK

{
   "process_id": 12345,
   "url": "https://example.com/12345.json"
}

401 Unauthorized

{
    "error_code": "03-20001",
    "ticket_id": "",
    "error_message": "Invalidate api token. Make sure input token are equal the initial token, and it is case sensitive. Or you could try to reset token credential to get new a token certification value"
}

Upload Task File

Once the aggregation task is initiated and you have acquired the process_id and url from the first step, proceed to upload the task file. Ensure that the file adheres to the format outlined below.

Task file format

[
   {
      "digest": "0x123..abcd",
      "public_key": "0x123..abcd",
      "signature": "0x123..abcd"
   },
   {
      "digest": "0x123..abcd",
      "public_key": "0x123..abcd",
      "signature": "0x123..abcd"
   },
   // ...
   {
      "digest": "0x123..abcd",
      "public_key": "0x123..abcd",
      "signature": "0x123..abcd"
   }
]

Upload task file to the provided URL

You can use curl command to upload such file to the url provided in the response

curl -X PUT -H 'Content-Type: application/json' -d @input.json https://example.com/12345.json

Notify PQScale to start processing the aggregation task

After successfully uploading the task file, inform PQScale to commence processing. This notification triggers the aggregation process, utilizing the data provided in the task file.

POST /v1/pqscale/aggsign/notify/:process_id

Path Parameters

Name	Type	Description
:process_id*	String	The process id of the job

Headers

Name	Type	Description
Authorization*	String	Your API Key

POST /v1/pqscale/aggsign/notify/:process_id

Path Parameters

Name	Type	Description
:process_id*	String	kqB6XaYl1qOM

Headers

Name	Type	Description
Authorization*	String	Q64OzigFSUUr

200: OK