Getting Started with the OMN API

OMN (Online Media Net) by apollon is an omnichannel marketing platform covering Product Information Management (PIM), Digital Asset Management (DAM), Channel Management (CM) and Workflow Management (WFM). Its REST APIs let you integrate OMN into your applications: upload, manage and retrieve OMN data, automate and start workflows, and retrieve status information.

You can call the APIs from any programming language with HTTP support, from HTTP/REST clients like Postman or Insomnia, or from the command line with curl. Simple GET endpoints even work directly in a web browser.

Prerequisites

  • An OMN installation reachable via HTTPS. All examples use the placeholder <OMN_SERVER> — replace it with your installation’s host name. API requests always go to your own OMN server, not to this documentation site.

  • An OMN user account.

  • A JWT access token for that user — see Authentication for how to obtain one.

Your first request

  1. Retrieve an API (JWT) token — see Authentication.

  2. Pick an endpoint in the API Reference. A good first candidate is /api/core/v1/dam/dirs/retrieve, which reads the DAM folder tree.

  3. Replace <OMN_SERVER> and <TOKEN> with real values and run:

curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rncTid": "MAM",
    "level": 1
}'

This retrieves the first level of the DAM directory tree of the MAM root node container. The response is a JSON structure describing the folders your user is allowed to see. If you get a 401 instead, your token is missing or expired — see Error Handling.

The APIs at a glance

API Base path OpenAPI specification

Core API (PIM, DAM, CM, PEO, Common)

/api/core/v1

core-api-openapi.yaml

Workflow API (part of the Core spec)

/api/v1/workflow

omn-workflow-api.yaml

Search API

/api/v1/search

omn-search-api.yaml

  • The Core API covers the main OMN modules to retrieve and manage the modules' resources — assets, versions, variations, directories, products, classifications, channels, keywords, glossaries and more.

  • The Workflow API manages processes (workflows), tasks and jobs. Its endpoints are included in the Core API specification.

  • The Search API offers full-text search, combined queries (for example facet search), sub-searches (join), type-ahead and search suggestions over the supported OMN resources.

All endpoints, parameters, request bodies and sample responses are browsable in the API Reference (Swagger-UI) — use the dropdown at the top to switch between the API definitions — and in the generated endpoint reference pages (see the sidebar). The raw OpenAPI documents are linked in the table above; the merged Core API spec is also available as JSON.

Trying requests directly from the API Reference

You can send requests to your own OMN installation straight from the API Reference:

  1. In the Servers box, replace the omnServer value with your OMN host name.

  2. Click Authorize and paste your JWT access token (see Authentication).

  3. Open an endpoint, click Try it out, fill in the parameters and execute.

Because the request is sent by your browser from this documentation site, your OMN installation must allow cross-origin requests (CORS) from this site’s origin. If the browser console reports a CORS error, either adjust the installation’s CORS configuration or copy the generated curl command and run it from a terminal instead — the curl command works regardless of CORS.

Next steps

  • Authentication — obtain and refresh tokens for long-running integrations.

  • REST API Usage — URI schema, OMN operations (query/retrieve/persist/perform) and bulk processing.

  • Error Handling — status codes and the error response format.