Authentication

NestAPI uses API keys. Every request must include your key in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_API_KEY

Getting a key

You can obtain keys in two ways:

Dashboard — create and manage keys from your NestAPI account.
API — if you hold an Admin-class key, manage keys programmatically via the account endpoints.

Sign up for a trial

New to NestAPI? Start a trial to get a key.

Making an authenticated request

curl https://api.nestapi.com/v1/auth/validate \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.nestapi.com/v1/auth/validate", {
  headers: { Authorization: `Bearer ${process.env.NESTAPI_KEY}` },
});
console.log(await res.json());

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", apiKey);
var res = await http.GetAsync("https://api.nestapi.com/v1/auth/validate");

GET /v1/auth/validate confirms the key is active and returns basic identity info (Valid, UserId) — a quick way to check a key works.

Verifying a key

Two account endpoints help you check a key’s state:

Endpoint	Purpose
`GET /v1/auth/validate`	Confirms the key is active and returns basic identity info.
`GET /v1/apiKey/validUntil`	Returns the key’s expiry date (or `31/12/9999` if it never expires).

Key classes

Class	Can do
Usage	Submit nesting and importer requests. The default.
Admin	Everything a Usage key can, plus manage the account’s keys, browser origins, and fairness.

Security

Treat API keys like passwords. Never embed them in client-side code or commit them to source control. For browser-based apps, restrict a key to specific origins with the allowed-origins endpoints and keep long-lived keys server-side.

Rotate keys periodically, and set an expiry for time-boxed integrations.
Disable a compromised key immediately.

Key creation, rotation, and revocation can be driven either from your NestAPI dashboard or through the API with an Admin key.

Getting Started

Guides

Concepts

Account

API Reference

Getting a key

Sign up for a trial

Making an authenticated request

Verifying a key

Key classes

Security

​Getting a key

Sign up for a trial

​Making an authenticated request

​Verifying a key

​Key classes

​Security

Getting a key

Making an authenticated request

Verifying a key

Key classes

Security