Getting started

Yor first API call will be authentication. Please see Tokens resource description for details.
After this call you need to add two headers that will be used in each query to server:

  • X-Account-Name – specify here your account e-mail
  • X-Api-Key – specify here your token that you got using POST /api/v1/tokens

All API calls supports xml and json format. See resources description for examples.

Ресурсы

Company register templates
Company register templates

Ресурс Описание
GET /api/v1/industries/:industry_id/company_register_templates List of company level and own register templates per industry id
GET /api/v1/company_register_templates/:id Register templates details including list of risks and folders

Company users
Company users management. View add update delete your company users here.

Ресурс Описание
GET /api/v1/company_users Company users list
POST /api/v1/company_users Invite company user
DELETE /api/v1/company_users/:id Remove company user

Industries

Ресурс Описание
GET /api/v1/industries List of available industries (you need to know industry_id to create project)

Project users
Project users permission management. View grant and revoke permissions to access project.

Ресурс Описание
GET /api/v1/projects/:project_id/project_users List of granted users
POST /api/v1/projects/:project_id/project_users Add project permission to user
DELETE /api/v1/project_users/:id Revoke project permission from user

Projects
Projects management. View add update delete your projects here.

Ресурс Описание
GET /api/v1/projects List of available projects
GET /api/v1/projects/:id Project details
POST /api/v1/projects Create project
PATCH /api/v1/projects/:id Update project details
PUT /api/v1/projects/:id Update project details
DELETE /api/v1/projects/:id Delete project

Recommendations
Recommendations api. You can submit here your project related tags and get list of recommended risks

Ресурс Описание
GET /api/v1/projects/:project_id/recommendations Risks recommended for your project
POST /api/v1/projects/:project_id/recommendations Submit new project tags to adjust recommendations

Register bookmarks
User's template bookmarks

Ресурс Описание
GET /api/v1/register_bookmarks List of user's template bookmarks
PATCH /api/v1/register_bookmarks/:id Toggle bookmark state like/dislike. Pass register template id in path
PUT /api/v1/register_bookmarks/:id Toggle bookmark state like/dislike. Pass register template id in path

Register templates
Public register templates

Ресурс Описание
GET /api/v1/industries/:industry_id/register_templates List of public register templates per industry id
GET /api/v1/register_templates/:id Register templates details including list of risks and folders

Risk estimates
Risk estimates api. You can submit risk estimates here

Ресурс Описание
GET /api/v1/risks/:risk_id/risk_estimates Risk estimates
POST /api/v1/risks/:risk_id/risk_estimates Submit new estimate

Risks
Risks api. Manage your project risks here.

Ресурс Описание
GET /api/v1/projects/:project_id/risks List of project risks
GET /api/v1/risks/:id Risk details
POST /api/v1/projects/:project_id/risks Add new risk
PATCH /api/v1/risks/:id Change risk details
PUT /api/v1/risks/:id Change risk details
DELETE /api/v1/risks/:id Remove risk

Tasks
Tasks api. Manage your project tasks here.

Ресурс Описание
GET /api/v1/projects/:project_id/tasks List of project tasks
GET /api/v1/tasks/:id Task details with comments
POST /api/v1/projects/:project_id/tasks Add new task
PATCH /api/v1/tasks/:id Change task details
PUT /api/v1/tasks/:id Change task details
DELETE /api/v1/tasks/:id Delete task

Tokens
API authentication

Ресурс Описание
POST /api/v1/tokens This method authenticates you using your e-mail and password
DELETE /api/v1/tokens/:id This method invalidates your authentication token

Users
Users registration

Ресурс Описание
POST /api/v1/users Method to signup new user