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

# Introduction

> THE HIVE API — Plateforme de recrutement et jobboard pour le Cameroun

# Bienvenue sur l'API THE HIVE

THE HIVE est une plateforme de recrutement et un jobboard dédié au marché camerounais. L'API connecte trois acteurs : les **candidats** qui recherchent un emploi, les **recruteurs** qui publient des offres et gèrent les candidatures, et les **administrateurs** qui modèrent la plateforme.

## Concepts clés

<CardGroup cols={2}>
  <Card title="Candidats" icon="user">
    Les candidats créent un profil complet (CV, photo, compétences), consultent les offres d'emploi et postulent aux postes qui les intéressent.
  </Card>

  <Card title="Recruteurs" icon="briefcase">
    Les recruteurs représentent une entreprise vérifiée, publient des offres d'emploi et gèrent le pipeline de candidatures.
  </Card>

  <Card title="Candidatures" icon="file-lines">
    Chaque candidature suit un cycle de vie clair : reçue, à rencontrer, en cours, entretien passé, embauché ou refusé.
  </Card>

  <Card title="Entreprises" icon="building">
    Les entreprises sont vérifiées par l'administration avant de pouvoir publier. Chaque recruteur est rattaché à une entreprise.
  </Card>
</CardGroup>

## Comment ça marche

```mermaid theme={null}
sequenceDiagram
    participant Recruteur
    participant Plateforme
    participant Candidat

    Recruteur->>Plateforme: Inscription + vérification entreprise
    Plateforme->>Recruteur: Compte validé par l'admin
    Recruteur->>Plateforme: Publier une offre d'emploi
    Candidat->>Plateforme: Rechercher et consulter les offres
    Candidat->>Plateforme: Postuler (CV + lettre de motivation)
    Plateforme->>Recruteur: Notification nouvelle candidature
    Recruteur->>Candidat: Mise à jour du statut (entretien, embauché)
```

## Base URL

Toutes les routes sont préfixées :

```
https://api.wethehivers.com/v1/api
```

En développement local :

```
http://localhost:3091/api
```

## Démarrage rapide

<Steps>
  <Step title="Créer un compte">
    Candidat : `POST /api/auth/candidate/register` — Recruteur : `POST /api/auth/recruiter/register`
  </Step>

  <Step title="Se connecter">
    `POST /api/auth/login` — renvoie un access token (15 min) et un refresh token (7 jours).
  </Step>

  <Step title="Explorer l'API">
    Candidat : consulter les offres et postuler. Recruteur : attendre validation admin, puis publier des offres.
  </Step>

  <Step title="Swagger UI">
    La documentation interactive complète est disponible en local sur `http://localhost:3091/api/swagger-ui.html`.
  </Step>
</Steps>