Send Requests

Follow these guidelines when sending requests with the Business Intelligence API.

Required Information

The following information is needed for successful authentication and successful requests to the APIs.

Tip:

To see a larger version of an image in the table, right-click the image and open it in a new browser tab.
Information Location Set by Example

Authentication Server URL

(This is the rest_server for the authentication APIs)

  • API account dialog: click the side menu, click Administration, click System, click API Accounts, click Edit, and then view the Authentication Server URL.

  • API account details email: click the side menu, click Administration, click System, click API Accounts, click Edit, and then click Send Details. The generated email contains the authentication server URL.

Oracle

Screenshot of the account page with the Authentication Server field in a red box

Screenshot of the email with the Authentication Server field in a red box

Application Server URL

(This is the rest_server for the Business Intelligence data APIs)
  • API account dialog: click the side menu, click Administration, click System, click API Accounts, click Edit, and then view the Application Server URL.
  • API account details email: click the side menu, click Administration, click System, click API Accounts, click Edit, and then click Send Details. The generated email contains the application server URL.

Oracle

Screenshot of the account page with the Application Server field in a red box

Screenshot of the email with the Application Server field in a red box

Account Name
  • API account dialog: click the side menu, click Administration, click System, click API Accounts, click Edit, and then view the account name.
  • API account details email: click the side menu, click Administration, click System, click API Accounts, click Edit, and then click Send Details. The generated email contains the account name.

Customer

Screenshot of the account page with the Account Name field in a red box

Screenshot of the email with the Account Name field in a red box

Client ID
  • API account dialog: click the side menu, click Administration, click System, click API Accounts, click Edit, and then view the Client ID.
  • API account details email: click the side menu, click Administration, click System, click API Accounts, click Edit, and then click Send Details. The generated email contains the Client ID.

Autogenerated

Screenshot of the account page with the Client ID field in a red box

Screenshot of the email with the Client ID field in a red box

Password

  • Can't be looked up.

  • Can be reset from the sign in page by clicking Can’t sign in? and then following the instructions.

You can't use the BI API account to sign in to Reporting and Analytics.

Customer

Screenshot of the sign in page with “Can’t sign in?” in a red box towards the bottom.

Enterprise Shortname

(This is used as the orgIdentifier in the BI data APIs)

  • API account dialog: click the side menu, click Administration, click System, click API Accounts, click Edit, and then view the enterprise shortname.

  • API account details email: click the side menu, click Administration, click System, click API Accounts, click Edit, and then click Send Details. The generated email contains the enterprise shortname.

Oracle

Screenshot of the account page with the Enterprise Shortname field in a red box

Screenshot of the email with the Enterprise Shortname field in a red box

Location Reference

(locRef needed as request parameter in almost all BI data APIs)

getLocationDimensions API returns a list of all locations within the enterprise, it includes the locRef information.

Oracle, partner, or customer

Red boxes around different locref examples.

URL Structure

Use the following URL structure to access the Business Intelligence API endpoints:

https://rest_server/endpoint-path

Where:

  • endpoint-path is the relative path that defines the REST resource. For a complete list of REST endpoints, see the Tasks section in this REST API document.

  • rest_server is the REST server to contact for your API account.

    • For the Authentication APIs, the rest_server is the Authentication Server as mentioned in the API account activation email or API account details screen. This URL is specific to your cloud environment.

      Example: https://mydomain-idm.oracleindustry.com

    • For the Business Intelligence data APIs, the rest_server is the same as the domain used for Reporting and Analytics once logged in. This URL is specific to your cloud environment.

      Example: https://mydomain.oracleindustry.com

Request Methods

You can perform query operations on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
POST

Get sales and operations totals, point of sale definitions, cash management, kitchen performance, employee performance, fiscal transactions, and control totals.

Request Media Types

Unless specified otherwise, the Oracle MICROS Business Intelligence REST API supports application/json.

Headers

The Business Intelligence REST API supports headers that can be passed in the header section of an HTTP request or response.

Header Description and Example

Accept

Media type for the response body. Unless an operation specifies otherwise, the type is application/json.

Example: Accept:application/json

Content-Type

Media type of the request body. Required for POST requests.

The following content types are used in the APIs:

  • API requests: Content-Type:application/json

  • Sign In request: Content-Type:application/x-www-form-urlencoded

Authorization
All API operations require an OAuth 2.0 based <id_token> for authentication purposes.

  • Bearer <id_token>

Access tokens are long strings. The following example has been truncated:

  • Bearer eyJ4NXQjUzI1Ni......VkdVAZrb_fw

You obtain the access token by using the Authentication service token URL with a client ID, authorization code, code verifier, an appropriate scope, and grant type.

See Authenticate.

Related Topics