> For the complete documentation index, see [llms.txt](https://doc.api-engagement.beta.gouv.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.api-engagement.beta.gouv.fr/api-reference/authentification.md).

# Authentification

L'API Engagement utilise des **clés API** pour authentifier les requêtes. Chaque partenaire dispose d'une clé unique associée à son compte.

## Utilisation

Transmettez votre clé API dans le header HTTP `x-api-key` à chaque requête :

```http
GET /v0/mission HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: votre-clé-api
```

Exemple avec cURL :

```bash
curl https://api.api-engagement.beta.gouv.fr/v0/mission \
  -H "x-api-key: votre-clé-api"
```

## Obtenir une clé API

> **La création d'une clé API nécessite l'aide d'un chargé de déploiement** avec qui vous êtes en contact. Cette personne pourra générer cette clé pour vous depuis le tableau de bord.

Une fois obtenue, votre clé est consultable et gérable depuis votre tableau de bord partenaire.

## Sécurité

Votre clé API confère un accès complet à votre compte partenaire. Prenez les précautions suivantes :

* Ne partagez jamais votre clé dans un dépôt Git public
* Ne l'exposez pas dans du code côté client (JavaScript navigateur, application mobile)
* Stockez-la dans une variable d'environnement côté serveur
* En cas de compromission, contactez votre chargé de déploiement pour la renouveler

## Réponse en cas d'erreur

Si la clé est absente ou invalide, l'API retourne :

```http
HTTP/1.1 401 Unauthorized
```

```json
{
  "ok": false,
  "code": "UNAUTHORIZED",
  "message": "Unauthorized"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.api-engagement.beta.gouv.fr/api-reference/authentification.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.