API Usage Overview

The Nomad Media API conforms to the OpenAPI Specification 3.0 published by Swagger. Nomad Media's API is RESTful, supports GET, POST, PUT, and DELETE methods, and can accept either URI or JSON-formatted requests. Nomad Media uses camelCase in parameter names.

Nomad Media's API can be used in one of two ways:

• Direct API calls: Send individual API calls to enact operations within Nomad Media.
• Custom code wrapper: Wrap one or more API calls within your own code for more complex automation.

Primary APIs

There are two primary APIs:

• Admin API — Administrative operations for managing content, users, and system configuration.
• Portal API — End-user-facing functionality for content delivery and search.

Some endpoints (such as login and authentication) are shared between both APIs. Most endpoints are specific to one or the other.

API Paths

Your Nomad Media AWS administrator will provide you with custom links to the Admin API and Portal API paths.

You can also determine your API paths by opening the respective application in a browser, opening the browser's Network tab in DevTools, and logging in. The login request headers will show the API URL for that application.

Available Endpoints

Nomad Media API endpoints follow the pattern:

/basepath/api/module/action

Endpoints vary in the types and depth of their functionality. Detailed, project-specific endpoint documentation is available at the API documentation link provided by your Nomad Media administrator.

URI Request Format

To make a URI request, use the API call directly in a URL. Calling an endpoint with an /action triggers the action's default functionality.

For example, this URI request logs out the authenticated user:

POST https://admin-app.sampleSite.nomad-cms.com/api/account/logout

Some endpoints also accept parameters appended to the action URL for simple, parameterized requests.

Authentication

With only a few exceptions, all API endpoints require authentication via either JWT Token Authorization or API Key Authentication. Both are accepted interchangeably on any authenticated endpoint.

The exceptions are primarily the login and forgot-password endpoints.

JSON Request Format

JSON requests allow you to send multiple parameters to an endpoint, giving you full control over the system.

Key criteria for JSON requests:

• UTF-8 encoding
• Each line must be a valid JSON string representing a single request item.
• Null entries are not included in the request body.

HTTP Status Codes

Nomad Media's API returns HTTP status codes to indicate the state of each request, followed by any response data in JSON format. Status codes should be interpreted in the context of the specific request.

For example, a 404 response to a request for an asset by ID means "The Asset ID was not found," whereas a 400 for a job status check means "The Job ID was not found or the JobStatus was not valid."