Link Search Menu Expand Document


Authenticating Users

Platform API

Last updated on July 11, 2018

If you are programmatically accessing the OpenX API, you must provide a method to authenticate a user. The OpenX API uses OAuth 1.0 to authenticate users. The following explains your options.

Your Authentication Options

You can programmatically authenticate an OpenX user in one of three ways:

  • Use the client libraries provided by OpenX. (Recommended)
  • Use a third-party library that already implements an OAuth 1.0 scheme. Note that OpenX does not support or manage the content of these libraries. (Recommended)
  • Write your own authentication code. OpenX provides a brief OAuth reference for those who want to take this approach.

Credentials Supplied by OpenX

When you become an API customer, OpenX provides you with the following credentials which you will use in initial authentication calls.

UsernameYour account username provided by OpenX.
PasswordYour account password provided by OpenX.
Consumer KeyThe ID portion of your Consumer credentials provided by OpenX.
Consumer SecretThe Consumer secret can be thought of as the password for the Consumer credentials.
OAuth RealmThe realm value is a string, generally assigned by the origin server. In this case, the realm parameter is used for your OpenX server instance.
For example, OAuth realm=””.