Methods

Objects

api-key

Manage authentication with Api Keys

Method Description
api-key.all Get all API keys linked to your account.
api-key.create Create a new Api-Key
api-key.delete Delete an Api-Key
api-key.edit Change the name of an API key. You can change the name of an API key l...

Methods

api-key.all

Description

Get all API keys linked to your account.

Signature

method: api-key.all

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array List of API keys Array of Authentication.ApiKey objects.

api-key.create

Description

Create a new Api-Key

Signature

method: api-key.create

params: [string name]

Parameters

Parameter Type Description NULL
name string The API key name. NO

Result

Type Description Format/Object
object The newly created API Key Object: Authentication.ApiKey

api-key.delete

Description

Delete an Api-Key

Signature

method: api-key.delete

params: [int id]

Parameters

Parameter Type Description NULL
id int The id of the API key to be deleted. NO

Result

Type Description Format/Object
bool True if API key deleted.

api-key.edit

Description

Change the name of an API key. You can change the name of an API key linked to your account.
Note: you cannot change the API key itself.

Signature

method: api-key.edit

params: [int id, string name]

Parameters

Parameter Type Description NULL
id int The id of the API key to be changed. NO
name string The new name of the API key. NO

Result

Type Description Format/Object
object The edited API Key Object: Authentication.ApiKey