Upload Sesskeys API

This API is used to upload sesskeys for completes. The referenced project must be in the Closed - Waiting for IDs state. Only one set of sesskeys will be saved for a project. Once uploaded, the project state is moved to Closed - Ready for Billing. If you do not upload sesskeys, all real-time completes will be accepted after the project has been closed (waiting for completes) for x days (customer-specific).

Command

"client/uploadSesskeys/1"



Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "client/uploadSesskeys/1"

rfg_id String

RFG project identifier. This is the identifier you received when you submitted the project.

sesskeys String[]

Array of sesskeys for completes to be credited on the referenced project.


Outputs

The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the following is included in the response field:

Name Type Description
uploaded Integer

Number of good sesskeys uploaded.

invoice_id String

The RFG invoice number for reference.


Example Command

{
     command : "client/uploadSesskeys/1",
     rfg_id : "RFG12345-001",
     sesskeys : ["58233a3ce4b0d80719f6806d"," 582339efe4b03b423e66e297"]
}

Example Response

response : {
     uploaded : 1,
     invoice_id : "INV123456"
}