API

Documentation

Version 1.0

JSON Data Structure

The AutoTechJobs API is built on a flexible JSON data structure that allows for maximum customization and extensibility. All data is represented as JSON arrays and objects, enabling you to:

Flexible Job Data

  • Custom job fields and attributes
  • Dynamic job requirements and qualifications
  • Flexible job location specifications
  • Custom application workflows

Extensible Employer Profiles

  • Custom company attributes
  • Dynamic company benefits
  • Flexible company location data
  • Custom employer branding

Example Job Structure

{
  "job": {
    "title": "Software Engineer",
    "location": {
      "city": "London",
      "remote": true,
      "custom_fields": {
        "timezone": "UTC",
        "travel_required": false
      }
    },
    "requirements": [
      {
        "type": "experience",
        "years": 3,
        "custom_fields": {
          "specific_tech": ["React", "Node.js"]
        }
      },
      {
        "type": "education",
        "degree": "Bachelor",
        "field": "Computer Science",
        "custom_fields": {
          "preferred_schools": ["MIT", "Stanford"]
        }
      }
    ],
    "custom_fields": {
      "salary_range": {
        "min": 50000,
        "max": 80000,
        "currency": "GBP"
      },
      "benefits": {
        "health_insurance": true,
        "stock_options": true,
        "custom_benefits": ["Flexible hours", "Remote work"]
      }
    }
  }
}

Key Features

The flexible JSON structure enables you to:

  • Add custom fields to any data structure
  • Create dynamic job requirements
  • Build custom application workflows
  • Store additional metadata
  • Implement custom business logic

Best Practices

Naming Conventions

  • Use camelCase for field names
  • Prefix custom fields with custom_
  • Use descriptive names for nested objects

Data Types

  • Use arrays for lists of items
  • Use objects for complex data structures
  • Use null for optional fields
  • Use timestamps for dates

Validation

While the API is flexible, it does provide validation for certain core fields to maintain data integrity. Custom fields are generally not validated beyond basic JSON structure.

Important Notes

  • Always validate custom fields on the client side
  • Use descriptive field names for better maintainability
  • Consider the impact of custom fields on search and filtering
  • Document your custom fields for other developers

For more information about specific API endpoints, see the relevant sections in the API documentation.