Overview

The Nxsys API uses OAuth 2.0 for authentication.

Why OAuth 2.0?

OAuth 2.0 is an authorization framework that allows third-party applications to obtain limited access to user accounts on an HTTP service. It works by delegating user authentication to the service that hosts the account, and authorizing third-party applications to access the user's information.

OAuth 2.0 Flows

There are four types of OAuth 2.0 flows:

  1. Create a Client Application
  2. Get the Client ID and Client Secret
  3. Get the authorization code
  4. Exchange the authorization code for an access token
  5. Refresh the access token

What do you need to prepare?

To use OAuth 2.0 with the Nxsys API, you'll need to prepare the following:

  1. Redirect URL: This is a crucial component of the OAuth 2.0 flow. The redirect URL (also known as callback URL) is the endpoint in your application where the user will be sent after they've successfully authenticated with the Nxsys API. You'll need to:
    • Choose a secure URL within your application
    • Ensure it's capable of handling the OAuth response
    • Register this URL with Nxsys when setting up your application

    For example, your redirect URL might look like: https://yourapplication.com/oauth/callback
    Important: Always use HTTPS for your redirect URL to ensure secure communication.
Table of Contents