# API Overview

# Supported APIs

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.

# 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

# 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: 5/11/2021, 6:25:06 PM