Skip to content

Query the information and status of the task ​

GET https://decrypt.nikola-lab.cn/openapi/v1/decrypt/task/{uuid}/information (Query the information of decryption tasks)

Parameter NameParameter TypeValue TypeNote
uuidquerystringThe uuid of decryption task

Request Data Example

  • There is no JSON structure data, so no examples are available. Please place the 'uuid' parameter in the URL for transmission
  • ⚠️URL carrying parameters does not require {}

Response Data

Parameter NameParameter TypeValue TypeNote
finishbodybooleanThis variable can be used to determine whether the task is completed, and the 'keysOrLink' variable is only valid after completion
keysOrLinkbodystringThe concatenation string of the key or the link to download the key file, please refer to the paragraph below that explains this variable in detail

Detailed description of keysOrLink:

  • In the case of decryption generating a small number of keys, this variable stores the result of concatenating the HEX string of the key together.

    • Splitting with ',' (English comma) during splicing.
    • Such as: daf7fabfff41,ffffffffff41,ba6a550955e1
  • When decryption generates a large number of keys, this variable stores the download link information of the binary file of the keys.

    • The binary key file has no unnecessary segmentation, and the keys binary data is stored together in order. It needs to be downloaded using the Keys Download API, which only returns key link information
    • Such as: {'size': 16411, 'link': 'b82a906b4bd708b7f56c65c85930d6818fd8d0c0'}

      size is keys count,link is link information of the key file, which is currently for reference only

  • If no valid key is decrypted, this variable is always null

  • Check if 'keysOrLink' is a valid JSON string, if so, download the key file

Response Data Example

json
// When decryption is not completed, the API returns the following JSON information
{"finish":false, "keysOrLink":null}
json
// After decryption is completed, a small number of keys are generated, and the API will directly return the keys
{"keysOrLink": "daf7fabfff41,ffffffffff41,ba6a550955e1", "finish": true}
json
// After decryption is completed, a large number of keys are generated, which need to be downloaded through the download API
{"keysOrLink": {"size": 16411, "link": "b82a906b4bd708b7f56c65c85930d6818fd8d0c0"}, "finish": true}

Download the keys generated by the decryption task ​

GET https://decrypt.nikola-lab.cn/openapi/v1/decrypt/task/{uuid}/keys (Download keys file)

Some decryption tasks only generate a small number of keys, which can also be downloaded using this API

Parameter NameParameter TypeValue TypeNote
uuidquerystringThe uuid of decryption task

Request Data Example

  • There is no JSON structure data, so no examples are available. Please place the 'uuid' parameter in the URL for transmission
  • ⚠️URL carrying parameters does not require {}

Response Data

  • The body of the HTTP response is the binary stream of the key file, which can be saved and used directly

Response Data Example

  • The downloaded file is a binary stream data return, and does not require a format example similar to JSON

Power by Nikola-LAB