Skip to content

WebSocket wss://decrypt.nikola-lab.cn/openapi/v1/decrypt/result/notify (Listen the decrypt result from server)

This interface is used to create a WS long connection with the decryption system for your server, listening for changes in the decryption results generated during the connection. By using this interface, you can to some extent reduce the frequency of actively querying and decrypting results

Parameter NameParameter TypeValue TypeNote
appIdquerystringYour appId
timestampquerystringUnix standard timestamp
noncequerystringRandom number
signaturequerystringSigned HEX, please read the following document to learn how to generate a signature
signature_methodquerystringAn algorithm for hashing signatures
  • Due to the protocol of WebSocket, parameters can only be transferred in querystring
  • Please refer to this document for instructions on generating signatures and signature algorithms: Signature Docs
  • WebSocket does not support returning error messages. Please strictly follow the document link above to handle the authentication process to avoid errors and wasting valuable time due to the inability to debug through exception messages.
  • If you encounter any error codes for HTTP 500, please contact our company for troubleshooting. If it is an error code for HTTP 400, please self check if the parameters of the authentication process are correct
  • The authentication process of this WebSocket interface is consistent with the parameters required for the authentication process of the HTTP interface. You can consider reusing the generation function of HTTP's authentication parameters
  • ⚠️ This interface is read-only, please do not write any data to this interface. Otherwise, it will result in the link returning an error message and the link being closed with a status code of 1008
  • ⚠️ Like other HTTP APIs, this WebSocket API is only available for server-side calls, otherwise it may lead to appSecret leakage and interface theft
  • ⚠️ In the following two situations, this WS interface will not report changes in decryption results, so please be sure to cooperate with the Query by http request when using it
    1. The decryption task has been completed before the WS link is completed
    2. Repeatedly submitting tasks with the same type and parameters

Notify data

Parameter NameParameter TypeValue TypeNote
uuidjsonstringThe uuid of decryption task
keysOrLinkjsonstringThe concatenation string of the key or the link to download the key file

About keysOrLink description, see: Decrypt result

Notify data example

json
{"uuid":"60886f32-2633-4ae2-8300-df68edb8d5a6", "keysOrLink":"abbbecebe56f"}

Power by Nikola-LAB