# Navarik Bridge HTTP API Overview

# API support

The APIs documented on this site are officially supported by Navarik, unless they are marked as deprecated. Don't consume any Bridge API unless the API is documented on this site. You should consider all undocumented endpoints private, subject to change without notice, and not covered by any agreements.

# Version guidelines

The Bridge API is a versioned API. Navarik reserves the right to add new parameters, properties, or objects to the API without advance notice.

# URL Namespace

Precede all URLs listed in the documentation with Navarik provided environment URL and API version.

Supported environments:

  • https://api.navarik.com/bridge/v1 - production environment.
  • https://api.uat.navarik.com/bridge/v1 - user acceptance testing (UAT) environment for testing Navarik products with persistent user-created data.
  • https://api.demo.navarik.com/bridge/v1 - public demo environment for demonstrating Navarik APIs using ephemeral data.

# Authentication

The Bridge API uses API keys to authenticate requests. Identity information is provided to the APIs via a Authorization header with an API key as a Bearer Token.

Example:

Authorization: Bearer cfe516b8-7b6d-4e2e-a8b6-1286ea1429e4

Contact Navarik Support (opens new window) to obtain an API key.

# Media types

The API currently supports XML and JSON as exchange formats. Desired format can be specified using Accept request header.

All Date objects are returned in ISO 8601 format (opens new window): YYYY-MM-DDTHH:mm:ss.SSSZ

# Data types

There are JavaScript examples for each API call. All API objects are transmitted in JSON format, so any limitations of JSON types apply here. The object creation schema use a concise JavaScript format with the following field types.

# Primitive types

Type Description
string JSON-compatible string
text Large JSON-compatible string
int Integer
float Floating point number
boolean true or false
datetime ISO 8601 date and time, as a string
reference ID of another entity, a UUID string

# Catalog reference type

Catalog mapping functionality operates with the union type of either a catalog item reference or an object of following shape:

{
  name: string
  xref: string
}

# Common Errors

# Using a non-existent identity

{
  "error": "[Core] Authentication failed"
}

# Retrieving a resource by an unauthorized user

{
  "error": "[Core.RuntimeStore] Document <UUID> is not accessible by user <UUID>"
}
Last Updated: 7/20/2021, 9:58:21 PM