API

Documentation

Version 1.0

Authentication

The AutoTechJobs API uses API keys for authentication. This page explains how to obtain and use API keys to authenticate your requests.

Never share your API keys or include them in client-side code. Always store API keys securely on your server.

Obtaining an API Key

To obtain an API key, you need to register as a developer on the AutoTechJobs platform. Follow these steps:

  1. Sign in to your AutoTechJobs account
  2. Navigate to your account settings
  3. Select the "Developer" tab
  4. Click "Generate API Key"
  5. Provide a description for your API key (e.g., "Production App")
  6. Copy and securely store your API key

API keys are only displayed once when generated. If you lose your API key, you'll need to generate a new one.

Using API Keys

Include your API key in the Authorization header of your HTTP requests:

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET   "https://api.autotechjobs.co.uk/v1/jobs"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"

API Key Permissions

API keys can have different permission levels based on your account type and specific needs:

Permission LevelAccessAvailable To
Read-onlyCan only read data, no write operationsAll users
StandardRead and write access to your own dataRegistered employers and candidates
PartnerExtended access for integration partnersApproved partners

API Key Security

Follow these best practices to keep your API keys secure:

  • Never expose API keys in client-side code (JavaScript, mobile apps)
  • Store API keys in environment variables or secure key management systems
  • Rotate API keys periodically
  • Use different API keys for development and production environments
  • Restrict API key permissions to only what's necessary
  • Monitor API key usage for suspicious activity

Revoking API Keys

If an API key is compromised, you should revoke it immediately:

  1. Sign in to your AutoTechJobs account
  2. Navigate to your account settings
  3. Select the "Developer" tab
  4. Find the API key you want to revoke
  5. Click "Revoke Key"
  6. Generate a new API key if needed

OAuth 2.0 (Coming Soon)

In addition to API key authentication, we're working on implementing OAuth 2.0 for more secure and flexible authentication options. This will allow third-party applications to access the API on behalf of users without exposing their credentials.

Next Steps