Skip to content

Open API key

In order to be able to use Open API keys for requests in MIKE Cloud platform, Open API Account has to be first created. Creation of Open API Accounts and issuing of keys is performed in Mike Cloud Admin application. Only owners have access to manage API Accounts

:warning: Engine executions executed using a specific open api key run under the license of the relevant Open API Key Creator.

Create Open API Account for whole Site

Login to Mike Cloud Admin and click on Site Access tab and then on API Access inner tab to view available Open API Accounts. apiAccess.png

The view will list available API Accounts, if there are none or there is a need to create a new one, click on a bick plus button.

  • Use Create API Account button to create new Account
  • Use the Edit option in the context menu on the API Account row item.

Issue Open API Key

Once there is Open API Account available it is possible to create Open API Keys. Review the list of Open API Account and click on edit button next to one in question.

  • Use Create API Key button to create new API Key

Click on clipboard button to save key for later use in the requests to MIKE Cloud Platform. After closing this pane key will not be visible anymore. saveKey.png

Associate Open API Account with a project

In the context of the project Open API Account acts just as a user. In order for requests to MIKE Cloud Platform to be successfully authorised, project in question has to be shared with Open API Account which Open API Key belongs to.

To do that you can login to Mike Data Admin. Create a project or edit existing one. newProject.png

Add Open API Account as a member. It should have at least Contributor rights in most scenarios. createProject.png

Create Open API Account for subproject

It is perfectly suitable to create API accounts and keys at the subproject level. The creator must be the owner of the project. Currently this is possible only using Rest API , not yet available in Cloud Admin UI.