Skip to main content

Quick start

Welcome to the Ocuco Developer Portal.

The portal currently comprises two areas:

  • Docs - Developer documentation.
  • APIs - Interactive REST APIs.

These are accessed from the top menu.

Click the logo on the left to return to the landing page.

Portal-wide search is available from the top left search box.

Next to the search box on the right is the dark mode toggle.

Next to the dark mode toggle is the Tags link that you can click to locate content by its taxonomy tags.

Viewing topics​

When viewing a topic, the table of contents is shown as a collapsible sidebar.

Above the topic title are the breadcrumbs. Click the breadcrumb links to navigate up the document tree.

Below the topic are the tags and any links to the previous or next topic.

The right pane contains a list of topic headings.

Using the REST API docs​

The REST API docs include code samples, example responses and the ability to send API requests to the development servers.

The collapsible left pane contains a list of APIs and endpoints.

The middle pane contains the endpoint name and description, request parameters, responses and the schema.

The right pane contains authorisation details, code samples, request parameters, the Send API Request button and any response returned.

Authenticating with the development servers​

The authentication method depends on the API.

Authenticate with the Omni Public API development server​

To authenticate with the Omni Public API development server, you must pass the StorefrontOrigin. In the devex portal only, the header description is changed to the required value. Try this out on the Site -> Get sites endpoint.

  1. In the Request section of the middle pane, expand the Header Parameters section.
  2. Under StorefrontOrigin, copy the URL.
  3. In the Request section of the right pane, expand Parameters and click Show optional parameters.
  4. In the StorefrontOrigin box, paste the URL.
  5. Click Send API Request.

Authenticate with the Omni B2B API development server​

To authenticate with the Omni B2B API development server, you need to generate a bearer token:

curl --location 'https://devappsec.azurewebsites.net/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=integration' \
--data-urlencode 'client_id<client_id>' \
--data-urlencode 'client_secret=<client_secret>'

You can get the client_id and client_secret from the secret server.

  1. In the Request section of the right pane, expand Auth and paste the token in the Bearer box.
  2. Click Send API Request.