# Getting started

# Environments

Currently, there are 2 publicly accessible environments for Navarik Bridge. These are differentiable by the baseUrl and this is set as a variable in the collection (read below).

DEMO - For learning and demonstrating the capabilities of Bridge APIs. Available to anyone using a test API key.

PRODUCTION - Live production environment with client's real data. Available only to authenticated users using their unique API keys.

# 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

# 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.

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

# How to use bearer tokens for calls

For API endpoints which a bearer token is required, ensure that a bearer token is supplied in the header for the call to be successful.

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

Last Updated: 5/11/2021, 6:25:06 PM