How to Access API System

September 14, 2018 04:06 PM
list

API Info

You will need to generate you key to access your API account. Go to My Zone -> Manage Account -> API KEY.

api

Click generate key.

api2

If you have any problems with the key, just delete the key and regenerate the key.

Example:

api3

End Point is https://api.rendercore.com

Manual http://api.rendercore.com/swagger/ui/index

Must include api key in the header

Example: api-key:YourAPIKey

Json Sample

{

"JobName":"string",

"ScenePath": "string",

"AppName":"string",

"RendererName": "string",

"Version":"string",

"OutputName": "string",

"OutputType": "string",

"Frames":"string",

"ByFrame":0,

"JobType":0,

"JobPriority": 0,

"RenderTypeId": 0,

"RenderTypeName": "string",

"ProjectDirectory":"string",

"RenderScript": "string",

"UserMember": "string",

"UserProject": "string",

"ArchiveOutputMode": 0,

"PO": "string",

"DependJobId": 0,

"IsSendEmail": true,

"EmailAddress": "string",

"SendConfirm":true,

"HighRamMachines": true,

"RendererId": 0,

"OverWriteVrayFrameBufferPath":true,

}

Detailed Information

ScenePath

Ex. /myproject/aa/test.mb

AppName, RendererName, & OutputType

3dsmax Details

maya Details

cinema4d Details

lighwave Details

modo Details

blender Details

vray Details

Frames

Ex. 10,50,110-130,1000-1100

JobType

0 = Testing

1 = Premium

2 = Economy

JobPriority

1=High , 2, 3, 4, 5=Low

RenderTypeId

1 = Animation

2 = IRMap(MultiFrame Incremental)

3 = IRMap(Animation Prepass)

ProjectDirectory //Maya and Lightwave Only

Ex. myproject

ArchiveOutputMode

0 = Don’t Archive Individual Frames

1 = Archive Individual Frames (7z)

2 = ArchiveWhole Job (One 7z File)

IsSendEmail

true = enable email notification

false = disabled email notification

EmailAddress

Ex. ”test@test.com”

HighRamMachines //3dsmax & Maya Only true = enable

false = disabled

OverWriteVrayFrameBufferPath //3dsmax Only

true = enable,

false = disabled