NavigetGuideReference

Getting Started

Get started using the Naviget API in three short steps.

PrerequisitesCopied!

  1. Active Naviget account (sign up at naviget.com)

  2. Valid user role with API access permissions

Step 1: Obtain API CredentialsCopied!

  1. Sign in to your Naviget account

  2. Navigate to Account Settings → API Keys

  3. Click Create API Key

  4. Configure your key:

    1. Name: Descriptive identifier (e.g., "Production Server")

    2. Expiration: Recommended 90 days for security (defaults to never expire)

    3. Role: Defaulted (coming soon…)

  5. Generate Key and securely store the secret value

⚠️ Important: The API key secret is only shown once. Store it securely!

Step 2: Choose Your Authentication StrategyCopied!

API Keys (Recommended)

Add the following authorization header to your request:

Authorization: "ApiKey {YOUR_API_KEY}"

JWT Tokens

  1. Authenticate at /api/auth/signin to get your access token

  2. Include the bearer token in you authorization header:

Authorization: "Bearer {YOUR_JWT_TOKEN}"

Step 3: Make Your First Request!Copied! 

curl -X GET "https://api.naviget.com/api/users/me" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json"

Next StepsCopied!

  1. Explore our API Reference for more info on all our endpoints

  2. Get started implementing!

© 2025 Naviget