# API Access

# Prerequisites

You will need to have a registered account in IoT Open.

# Generate API-Key

API-Keys can be created using two methods. The first method generates a key without any time limit and is suited for creating integrations to your account. The other method generates a key with a valid time of one year. This is suited for a user session, for example a mobile app.

# Using the web interface

  1. Log in to the web interface e.g. https://lynx.iotopen.se
  2. Navigate to your profile by clicking the account image in the top right corner and choose My Account
  3. Click on Security and open the tab API-keys
  4. Click Create new API-Key at the bottom of the list
  5. Enter a name to identify the key
  6. Click Create

The key should now be visible on screen. For security-reasons this key can not be shown again. If a key is needed again please remove the key and create a new one.

# Using Auth Endpoint

The API endpoint Auth can be used to generate a new API-Key, this is the normal "login" API.

A POST request containing username and password as Basic auth is sent to the endpoint. The response contains either information about more steps needed such as sms-verification or the key.

Endpoint description can be found in the API-Documentation.