Package Exports

unl-js-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (unl-js-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

unl-js-api

A javascript SDK to wrap the UNL API. The library is written in TypeScript and it provides its own type definitions.

Install

npm install unl-js-api

yarn add unl-core

Usage

You can import the UnlApi class and create an instance by passing an UNL API Key. Replace "YOUR-UNL-API-KEY" with a valid key in the following snippet.

import UnlApi from 'unl-js-api';

const UNL_API_KEY = config.UNL_API_KEY;
const unlApi = new UnlApi('YOUR-UNL-API-KEY');

Next, the methods can be called by referencing the unlApi instance:

unlApi.recordsApi.getById('YOUR-PROJECT-ID', 'YOUR-RECORD-ID');

For information on how to generate an API key, along with usage examples follow the UNL developer documentation.