You are here: Developers > OpenX Platform API > Platform API reference > session service

session service

Last updated on January 11, 2018

The session service allows communication between OpenX and a user when the user logs in, interacts with, and logs out of the system. For more details, see authentication.

Logging into OpenX

GET /session

Log into OpenX.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/session --cookie "openx3_access_token=token_string"

Sample response

{
   "account": {
      ...
   },
   "custom_css": "",
   "locale": "en_US",
   "acl_mapping": {
      ...
   },
   "instance": {
      ...
   },
   "user": {
      ...
   },
   "sso_domain": "sso.openx.com",
   "api_version": "4.76.0.57"
}

Response data

Parameter Description

account

Details of the network or publisherAn account type that represents a business with ad space to sell. account. Information like timezone, currency, and creation date are returned.

acl_mapping

Access and permissions of a user.

api_version

Version of the API.

custom_css

Internal OpenX use. CSS detailing header color and logo customizations made within the UI.

instance

Details of the customer UI. Information like the global timezone (which an account can inherit), and delivery hostname/domain are returned.

locale

User selected language for the UI. This is set in the user settings.

To list all valid locale values, call GET /options/local_languages.

Current valid values:

  • de_DE = German.
  • en_US = English/United States.
  • fr_FR = French.
  • ja_JP = Japanese.

Default: en_US

In the UI, the Locale field.

sso_domain

OpenX domain of the UI instance.

user

Details the user. Information like the user's name, ID, and creation date are returned.

Return to top.


Logging out of OpenX

DELETE /session

Logout from OpenX.

Sample request

curl -X DELETE http://PUBLISHER-ui.openx.net/ox/4.0/session --cookie "openx3_access_token=token_string"

Sample response

{}

Return to top.

Feedback form