For developers who plan to integrate their applications with OpenX, this topic explains the basics of using the OpenX Platform API which is a JSON-based REST API. Authenticating users involves the following steps:
- Request an unauthorized request token.
- Authorize the user.
- Request an access token.
- Use the access token to access protected resources.
You can complete user authentication using one of two methods:
- Browser-based authentication: if you provide an interactive web-based login form for users, other than yourself.
- Programmatic authentication: if you access protected OpenX resources with your own credentials and do not provide a web-based login form for other users.
If you need support, see Support.
When making an API request, you must follow standard HTTP API request structure. This ensures the request is properly formatted as follows:
|HTTP method. For example, |
|OpenX server name or admin hostname. This is the same URI used to log into the OpenX UI.|
|API object or service. For example, |
|UID, ID, or request for specific values. For example, |
Note: An identifier is not required for all objects or services. Refer to the specific object or service for more information.
|Specific additional request information. The first parameter must begin with a question mark (|
The OpenX Platform API returns standard JSON responses to all standard HTTP API requests.