Login¶
Login to the cielo24 API to obtain an API access token for use when calling other methods. Optional arguments may be passed either as HTTP headers or query string parameters. Required arguments must be passed as query string parameters.
HTTP Method
-
GET/api/account/login¶
HTTP Headers — Optional
Provide x-auth-user with either x-auth-password or x-auth-securekey.
| Name | Details | |
|---|---|---|
| x-auth-user | Description | The username associated with this account |
| Allowed Values | String | |
| Example | john_doe |
|
| x-auth-password | Description | The password associated with this account |
| Allowed Values | String | |
| Example | example_password |
|
| x-auth-securekey | Description | A long term security key generated via generate_api_key |
| Allowed Values | Hex String | |
| Example | 968a8b637a5040159424872fffdb895b |
|
Query String Parameters — Required (always)
| Name | Details | |
|---|---|---|
| v | Description | The version of the API to use |
| Allowed Values | 1 | |
| Example | v=1 |
|
Query String Parameters — Optional
Provide username with either password or securekey.
| Name | Details | |
|---|---|---|
| username | Description | The username associated with this account |
| Allowed Values | String | |
| Example | username=john_doe |
|
| password | Description | The password associated with this account |
| Allowed Values | String | |
| Example | password=example_password |
|
| securekey | Description | A long term security key generated via generate_api_key |
| Allowed Values | Hex String | |
| Example | securekey=968a8b637a5040159424872fffdb895b |
|
Responses
| HTTP Code | Details | |
|---|---|---|
| 200 | Description | Success |
| Contents | {
"ApiToken": "The new API token (hex string)"
}
|
|
| 400 | Description | An error occurred |
| Contents | Error description (see Error Format for details) | |
Example Requests
GET /api/account/login?v=1&username=john_doe&password=example_password HTTP/1.1
Host: api.cielo24.com
GET /api/account/login?v=1&username=user&securekey=968a8b637a5040159424872fffdb895b HTTP/1.1
Host: api.cielo24.com
GET /api/account/login?v=1 HTTP/1.1
Host: api.cielo24.com
x-auth-user: john_doe
x-auth-key: example_password
GET /api/account/login?v=1 HTTP/1.1
Host: api.cielo24.com
x-auth-user: john_doe
x-auth-securekey: 968a8b637a5040159424872fffdb895b
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{ "ApiToken" : "7ca5dc5c7cce449fb0fff719307e8f5f" }