Robohead API Documentation - Authentication

RoboHead provides token based authentication. The token (also called as Api Key in RoboHead) can be generated by an Account Admin. The Api Key should be passed as "userApiToken" parameter to each REST API you use.

To generate a new API Key or to view an existing API Key for a user, Account Admin should user following steps:

Example of using Api Key: To get the list of active projects, use the below url:

https://yoursubdomain.robohead.com/project.do?userApiToken=yourApiKey&cmd=ListActiveProject

On invalid API Key, the url will return following JSON response:

{
	"returnCode":1,
	"errorMessages":[{"messageKey":"msg_error_invalidToken","detailedMessage":"Token key is invalid for performing operation."}],
	"success":false
}

On API execution, the url will return JSON response as described in the API documentation for project module.