API Keys¶

The API key is the main thing that is needed for the integration. This is the same as the hash of the user's session gotten by the auth call, only with an infinite lifetime.

Unlike the user's session:

• the API key will not be deleted if the user logs out or changes the password,
• you do not need to renew the key periodically,
• you do not transfer or store the username and password,
• you can delete the key at any time if there is a suspicion of compromise,
• you can create a separate key for each individual integration.
• if request rate limit is exceeded, regular users will not be blocked, because API keys have a separate counter.

In one user's account, you can have up to 20 API keys intended for different external integrations. To distinguish keys from each other, you should give them meaningful names.

Find more details on API keys usage in our instructions.

API Key object¶

{
  "hash": "c915157ac483e7319b0b257408bc04e1",
  "create_date": "2021-10-29 12:00:36",
  "title": "Integration with My Super App"
}

• hash - string, 32 chars. Hash of an API key.
• create_date - date/time. Key creation date.
• title - string. Key title.

Actions¶

API path: /api/key.

create¶

Creates a new API key.

This call is available only to the master user and only with a standard session obtained using a login/password via /user/auth.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/api/key/create' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "title": "My Super App"}'

https://api.navixy.com/v2/api/key/create?hash=a6aa75587e5c59c32d347da438505fc3&title=My+Super+App

Response¶

{
  "success": true,
  "value": {
    "hash": "c915157ac483e7319b0b257408bc04e1",
    "create_date": "2021-10-29 12:00:36",
    "title": "My Super App"
  }
}

Errors¶

• 4 - User or API key not found or session ended. If the user session (hash param) is invalid or a non-standard session is used (for example, another API key).
• 13 - Operation not permitted. If a call with subuser's session hash.
• 268 - Over quota. If 20 keys have already been created in the user's account.

delete¶

Deletes API key.

This call is available only to the master user and only with a standard session obtained using a login/password via /user/auth.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/api/key/delete' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "key": "5063e191d734e87e17987953c7a9a086"}'

https://api.navixy.com/v2/api/key/delete?hash=a6aa75587e5c59c32d347da438505fc3&key=5063e191d734e87e17987953c7a9a086

Response¶

{
  "success": true
}

Errors¶

• 4 - User or API key not found or session ended. If the user session (hash param) is invalid or a non-standard session is used (for example, another API key).
• 13 - Operation not permitted. If a call with subuser's session hash.
• 201 – Not found in the database - if there is no specified API key in account.

list¶

Gets all of API keys for an account.

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/api/key/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'

https://api.navixy.com/v2/api/key/list?hash=a6aa75587e5c59c32d347da438505fc3

Response¶

{
  "list": [{
      "hash": "c915157ac483e7319b0b257408bc04e1",
      "create_date": "2021-10-29 12:00:36",
      "title": "My Super App"
  }, {
      "hash": "e3b7d1d727d21e064a190239b3403ee3",
      "create_date": "2021-11-19 16:06:03",
      "title": "AmoCRM integration"
  }],
  "success": true
}

Errors¶

• 4 - User or API key not found or session ended. If the user session (hash param) is invalid or a non-standard session is used (for example, another API key).
• 13 - Operation not permitted. If a call with subuser's session hash.