> ## 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

> Documentation de l'API REST JobAffinity (v1.10)

Bienvenue sur la documentation technique de l'interface de communication **JobAffinity**. Cette API de type REST permet d'interagir avec notre plateforme de recrutement de manière programmatique.

## Vue d'ensemble

L'API REST JobAffinity vous permet de :

* Accéder à vos offres d'emploi et candidatures
* Gérer les processus de recrutement
* Consulter et enrichir votre CVthèque
* Automatiser vos workflows via webhooks

## Caractéristiques principales

<CardGroup cols={2}>
  <Card title="Auto-découverte" icon="compass">
    Navigation intuitive : seule l'URL racine est nécessaire
  </Card>

  <Card title="Auto-documentée" icon="book">
    Schémas JSON-Schema inclus dans chaque réponse
  </Card>

  <Card title="RESTful" icon="network-wired">
    Architecture REST standard avec HTTPS et JSON
  </Card>

  <Card title="Versionnée" icon="code-branch">
    Gestion de versions pour migrations en douceur
  </Card>
</CardGroup>

## Démarrage rapide

<Steps>
  <Step title="Obtenir vos identifiants">
    Contactez le support : [support@intuition-software.fr](mailto:support@intuition-software.fr)
  </Step>

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

  <Step title="Explorer l'API">
    Utilisez les URLs fournies dans les réponses pour naviguer dans l'API
  </Step>
</Steps>

## URL de base

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

<Note>
  Cette URL racine est le seul point d'entrée dont vous avez besoin. Toutes les autres URLs vous seront fournies par l'API elle-même.
</Note>

## Format des échanges

* **Protocole** : HTTPS uniquement
* **Méthodes** : GET et POST
* **Format** : JSON (`application/json`)
* **Authentification** : HTTP Basic Auth

## Limitation de taux

<Warning>
  L'API est limitée à **45 requêtes par minute par adresse IP**. Dépasser cette limite entraînera des réponses HTTP 429 (Too Many Requests).
</Warning>

## Prochaines étapes

<CardGroup cols={2}>
  <Card title="Authentification" icon="key" href="/guides/authentication">
    Apprenez à vous authentifier et à effectuer vos premières requêtes
  </Card>

  <Card title="Architecture" icon="sitemap" href="/guides/discovery">
    Comprenez le principe d'auto-découverte et la navigation
  </Card>

  <Card title="Structure des réponses" icon="file-code" href="/guides/responses">
    Découvrez les champs spéciaux et la structure des réponses
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference">
    Explorez la documentation complète des endpoints
  </Card>
</CardGroup>

## Support

Pour toute question ou demande d'assistance :

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

<Warning>
  **Important** : Surveillez le champ `_expiration` dans la ressource racine. S'il devient différent de `null`, une migration vers une nouvelle version sera nécessaire.
</Warning>