Platform API Versioning Overview

Introduction
Create Token
Tags
Apollo Sandbox

Introduction

The NowSecure API is available to all customers to programmatically integrate with NowSecure Platform. We are currently in the process of developing new and improved API documentation, built using OpenAPI standards. We welcome you to try it out as we share and release more endpoints until it ultimately becomes a complete replacement for the API documentation located here, in the NowSecure Help Center.

NowSecure Platform has two primary APIs for REST endpoints, Hub 1 and Hub 2. The APIs are similar in functionality, but may have different documentation or endpoints for each, so you may need to browse both to find specific documentation for your use case. In addition to these REST API hubs, NowSecure Platform has a GraphQL Playground, and maintains the documentation on Help Center. For more information, view our GraphQL Apollo Sandbox Overview.

NowSecure API supports requests for analyzing assessment data. To access NowSecure APIs, you must have a NowSecure Platform account. 

Both Hubs are currently supported for RESTful API calls:

Create Token

Please see the Creating a Bearer Token article from within the NowSecure Platform UI.

Tags

The entire Graph should be considered supported unless otherwise annotated (e.g. with depreciated or experimental warnings). Please see the GraphQL Apollo Sandbox- Customizing NowSecure Platform Roles overview for more information on useful queries.

As the GraphQL API structure stabilizes, any Graph nodes we would like to remove will be annotated with a deprecation warning, which should include instructions on where best to query for the relevant data. We will continue to support queries on these deprecated nodes, but using them when authoring new queries in the GraphQL playground, for instance, will issue warnings. While it is not advisable to develop new application logic against deprecated nodes, we will not remove any deprecated nodes/functionality without a great deal of advanced warning. We intend to be extremely conservative about preserving backward-compatibility, warts and all – we consider any breakage of backward-compatibility to be a bug.

Apollo Sandbox

The Apollo GraphQL Sandbox is accessible here: https://api.nowsecure.com/graphql for queries that return more detailed results than the base queries documented on the Help Center. 


Please see our Apollo Sandbox Overview article for more information.

Comments

0 comments

Article is closed for comments.