You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Jim Lake edited this page Apr 26, 2015
·
1 revision
Authentication endpoints for API usage.
API Endpoint
All calls are made on the standard report endpoint:
https://report.data-cortex.com
Login
Retrieve a session_key for future communication with the API.
Will generate an email to the specified address to authenticate the user.
The email will contain a verification URL that should be clicked to enable
the session_key for access to the API. You will need to record and enter
the manual_code on that web page as well.
POST /api/1/login
Request Arguments
email - string - Email address of user to authenticate
Responses
200 OK
result - string - "new_browser" - Indicates a new authentication
session_key - string - Session key for this login. Should be sent in a cookie or body of subsquent API calls.
manual_code - string - Manual code for the verification process.
Logout
Disabled the current session.
POST /api/1/logout
Request Arguments
None
Responses
200 OK
Successfully disabled the session_key.
User Information
Get information about the logged in user.
GET /api/1/user
Request Arguments
None
Responses
200 OK
user_id - number - User ID
email - string - User email address
display_name - string - User display name
org_list - list of objects - List of organizations this user belongs to