> ## Documentation Index
> Fetch the complete documentation index at: https://api.jobaffinity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> JobAffinity REST API Documentation (v1.10)

Welcome to the technical documentation for the **JobAffinity** communication interface. This REST API allows you to interact with our recruitment platform programmatically.

## Overview

The JobAffinity REST API enables you to:

* Access your job postings and applications
* Manage recruitment processes
* Consult and enrich your candidate database
* Automate your workflows via webhooks

## Key Features

<CardGroup cols={2}>
  <Card title="Self-Discoverable" icon="compass">
    Intuitive navigation: only the root URL is needed
  </Card>

  <Card title="Self-Documented" icon="book">
    JSON-Schema included in every response
  </Card>

  <Card title="RESTful" icon="network-wired">
    Standard REST architecture with HTTPS and JSON
  </Card>

  <Card title="Versioned" icon="code-branch">
    Version management for smooth migrations
  </Card>
</CardGroup>

## Quick Start

<Steps>
  <Step title="Get your credentials">
    Contact support: [support@intuition-software.fr](mailto:support@intuition-software.fr)
  </Step>

  <Step title="Test authentication">
    ```bash theme={null}
    curl -X GET https://jobaffinity.fr/restapi/v1 \
         --basic --user login:password
    ```
  </Step>

  <Step title="Explore the API">
    Use the URLs provided in responses to navigate the API
  </Step>
</Steps>

## Base URL

```
https://jobaffinity.fr/restapi/v1
```

<Note>
  This root URL is the only entry point you need. All other URLs will be provided by the API itself.
</Note>

## Data Exchange Format

* **Protocol**: HTTPS only
* **Methods**: GET and POST
* **Format**: JSON (`application/json`)
* **Authentication**: HTTP Basic Auth

## Rate Limiting

<Warning>
  The API is rate-limited to **45 requests per minute per IP address**. Exceeding this limit will result in HTTP 429 (Too Many Requests) responses.
</Warning>

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/en/guides/authentication">
    Learn how to authenticate and make your first requests
  </Card>

  <Card title="Architecture" icon="sitemap" href="/en/guides/discovery">
    Understand the self-discovery principle and navigation
  </Card>

  <Card title="Response Structure" icon="file-code" href="/en/guides/responses">
    Discover special fields and response structure
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference">
    Explore the complete endpoint documentation
  </Card>
</CardGroup>

## Support

For any questions or assistance:

* Email: [support@intuition-software.fr](mailto:support@intuition-software.fr)
* Changelog: [https://jobaffinity.fr/restapi/changelog](https://jobaffinity.fr/restapi/changelog)

<Warning>
  **Important**: Monitor the `_expiration` field in the root resource. If it becomes different from `null`, a migration to a new version will be required.
</Warning>