Skip to main content

​
Overview

Spott API offers two types of endpoints with different authentication requirements:

Public Endpoints

No authentication required

API Key Endpoints

Require API key authentication

​
Public Endpoints

Public endpoints are accessible without authentication and are typically used for:
  • Vacancy Portal: Browse and apply for jobs
  • Candidate Portal: Submit applications and candidate information
  • Public Resources: Access publicly available data
These endpoints are ideal for embedding in your public-facing website or career portal.

​
API Key Endpoints

API Key endpoints require authentication and should only be used from secure, server-side environments.
API key-protected endpoints provide programmatic access to your Spott data and require authentication using an API key.

​
Getting Your API Key

  1. Log in to your Spott dashboard
  2. Navigate to Settings → API Keys
  3. Generate a new API key or copy an existing one

​
Using Your API Key

Include your API key in the request headers using the x-api-key header: 
curl -H "x-api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.gospott.com/v1/endpoint
Or in your application code: 
const response = await fetch('https://api.gospott.com/v1/endpoint', {
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

​
Best Practices

Never expose your API key in client-side code, public repositories, or version control. Use environment variables or secure key management systems.
Regularly rotate your API keys to minimize security risks. Generate a new key before revoking the old one to avoid service interruption.
Use separate API keys for development, staging, and production environments to isolate access and simplify key rotation.

​
Rate Limits

Rate limits apply to all API endpoints. Contact support@spott.io if you need higher limits.
  • Public Endpoints: 100 requests per minute per IP
  • API Key Endpoints: 1000 requests per minute per API key

​
Support

If you have questions about authentication or need help with API integration, contact us at support@spott.io.