Skip to content

Open a session

POST
/Login
curl --request POST \
--url https://api.eianalytic.com/ApiWeb.svc/Login \
--header 'Content-Type: application/json' \
--data '{ "email": "user@example.com", "password": "••••••••" }'

Exchanges account credentials for one token per database the account can reach. Each returned DbApi pairs a database with the token that authorises calls against it.

The session expires after 24 hours without activity.

Media typeapplication/json
object
email
required
string format: email
password
required
string format: password
Example
{
"email": "user@example.com",
"password": "••••••••"
}

One entry per database available to the account.

Media typeapplication/json
Array<object>
object
Key

The Key half of every response envelope.

object
StatusNumber
required

0 means OK. See the Conventions page for the full table.

integer
Description
required
string
Configs

Present on some responses; empty in the documented examples.

Array<object>
object
Value
Array<object>

A database paired with the token that authorises calls against it.

object
DataBase

One EI-Analytic™ database.

object
Id
integer
Name
string
DBName
string
GB

Storage quota in GB.

number format: float
Percentage

Percentage of the quota in use.

number format: float
NUsers
integer
IdAdmin
integer
Owner

Whether the authenticated account owns this database.

boolean
DateTimeExp

A .NET-serialised timestamp of the form /Date(1566511365000-0500)/: milliseconds since the Unix epoch, followed by a UTC offset. Note that other endpoints return plain yyyy-MM-dd HH:mm:ss strings instead — the two formats coexist in this API.

string
Token

The database token returned by Login. Sent in the request body, not in a header.

string
Example
[
{
"Key": {
"StatusNumber": 0,
"Description": "OK"
},
"Value": [
{
"DataBase": {
"Name": "eidb_mecanica",
"DateTimeExp": "/Date(1566511365000-0500)/"
}
}
]
}
]