Authentication

Authenticate to use Nova's platform and the API.

If you are a node provider and want to get access to the platform from the website, please authenticate by visiting https://novaenergy.ai/app and select "Create Profile" as a Digital Infrastructure Provider. You can sign in by typing a username and password of your choice or sign in with Google.

After the sign in screen, if you are a first time user, you would be taken to Create Profile page from which you would be prompted to fill out details about your profile, the type of provider you are, and contact information.

Using Authenticate from the API with cURL

We offer two methods for performing authentication: one using a TypeScript request with fetch, and the other with cURL. Regardless of the programming language you use, you can make a network request to our API for authentication and receive the necessary information in return.

//The URL of the endpoint
https://api-nova.onrender.com/api/users/authenticate

const email = 'your-email'; const password = '---'; const source = 'your-app.com';
const response = await fetch('https://api-nova.onrender.com/api/users/authenticate', { method: 'POST', headers: { Accept: 'application/json', 'Content-Type': 'application/json', }, body: JSON.stringify({ email, password, source }), });
const json = await response.json(); console.log(json);

In both the cURL and fetch requests, the source field plays an important role. It adds a custom data field to the user’s account, helping both you and the user recognize that they are signing into your website. While the source field is optional, we highly recommend using it to clearly identify your web application.

//The URL of the endpoint
https://api-nova.onrender.com/api/users/authenticate

curl -X POST "https://api-nova.onrender.com/api/users/authenticate" \
  -H "Content-Type: application/json" \
  -d '{"email": "[e-mail]", "password": "****-****-****-****", "source": "your-app.com"}'

Upon successfully signing in, you will receive a response containing a user object that includes an API key. This key is essential for authenticating future requests for the API endpoints.

// The URL of the endpoint
https://api-nova.onrender.com/api/users/authenticate

{
  "user":{
    "id" : "your-id-will-be-here",
    "email" : "your-email-will-be-here",
    "key" : "********-****-****-****",
    "level" : "00",
    "data" : {},
    "created_at" : "2024-02-28T11:02:39.180Z",
    "updated_at" : "2024-09-10T14:43:30.073Z",
    "deleted_at" : null,
    "username" : "null"
  },
  "existing":true
}

Getting an API key from the Dashboard

If you want to get the API key from the platform, after logging in as a Provider, on the home page of the dashboard, find the menu "Generate API Key." The provided key on this page is the key that can be used for the API. Currently only one key is supported per user.

To regenerate a new key, click "Generate a new key" after the listed key.