@nrfcloud/api-client-javascript

JavaScript API client for the nRFCloud.com REST API

Usage no npm install needed!

<script type="module">
  import nrfcloudApiClientJavascript from 'https://cdn.skypack.dev/@nrfcloud/api-client-javascript';
</script>

README

DRAFT"> nRF Cloud API API v1.0.0-preview.1 Swagger UI

Build Status npm preview version
Greenkeeper badge semantic-release Commitizen friendly Standard - JavaScript Style Guide

Provides the API documentation for the nRFCloud.com REST API.

:warning: This is a preview release and might be changed without notice.

:information_source: This documentation currently does not reflect the actual API used on nrfcloud.com. This project is a proof-of-concept.

API Documentation

The documentation in OpenAPI 3.0.0 format can be found here. You can open it in the Swagger API viewer to execute requests agains the API right in your browser.

JSON schema files

The response and request schemas from the API documentation are exported as JSON schema files in ./schemas can be included in JavaScript like this:

npm i @nrfcloud/api@preview

const {schemas} = require('@nrfcloud/api')