# API Coworkies : démarrer

Source: https://docs.coworkies.com/fr/api/

> Connectez vos outils à l’API v2 avec une clé limitée, effectuez une première lecture et consultez les guides d’intégration.

L’API Coworkies permet de lire des offres et des données d’annuaire ou de créer des offres depuis vos outils. L’URL de base est **`https://api.coworkies.com/v2`**. Les réponses sont en JSON.

## 1. Obtenir une clé adaptée

Pour un espace Pro, ouvrez **Space Admin → API Keys** et suivez [le guide des clés](https://docs.coworkies.com/fr/spaces/api-keys/). Pour les autres besoins, demandez un accès à [api@coworkies.com](mailto:api@coworkies.com).

Choisissez les permissions minimales. Une clé d’espace limite les données spécifiques prises en charge et les opérations sur les offres à cet espace. Les villes et les contenus publics ne sont pas tous filtrés par espace : consultez le comportement de chaque endpoint.

## 2. Effectuer une lecture

Configurez `COWORKIES_API_KEY` dans l’environnement du serveur ou son gestionnaire de secrets, puis exécutez :

```bash
curl --fail-with-body --max-time 30   'https://api.coworkies.com/v2/jobs'   -H "X-API-Key: ${COWORKIES_API_KEY}"
```

Vérifiez le statut HTTP et `success`. Les offres sont dans `data.jobs`. Une liste vide peut signifier que votre espace n’a pas d’offre active.

```json
{
  "success": true,
  "status": 200,
  "data": { "jobs": [], "total": 0 }
}
```

Lorsque le serveur active la pagination, `data.pagination` remplace le simple total. Voir [API des offres](https://docs.coworkies.com/fr/api/jobs/).

## 3. Choisir un guide

- [Authentification, réponses et erreurs](https://docs.coworkies.com/fr/api/authentication/) : en-têtes, permissions et nouvelles tentatives.
- [API des offres](https://docs.coworkies.com/fr/api/jobs/) : filtres, création, publication, doublons et retrait.
- [Annuaire et contenus](https://docs.coworkies.com/fr/api/reference/) : villes, espaces, blog, événements, état du service et retours.

## Ressources développeur

| Ressource | Utilisation |
|---|---|
| [Référence API](https://api.coworkies.com/docs/) | Exemples et champs complets. |
| [Swagger UI](https://api.coworkies.com/docs/swagger.html) | Référence interactive ; les requêtes d’écriture peuvent modifier des données réelles. |
| [Spécification OpenAPI](https://api.coworkies.com/openapi.yaml) | Importer ou générer un client. |
| [Référence LLM courte](https://api.coworkies.com/llms.txt) | Contexte d’intégration concis. |
| [Référence LLM complète](https://api.coworkies.com/llms-full.txt) | Détails d’intégration. |

La plupart des endpoints de données exigent une clé. Les informations API, retours, inscriptions newsletter, contenus de blog et flux Vine ont des routes publiques. **Health**, **Jobs**, **Cities**, **Spaces** et **Events** exigent une authentification. Gardez les clés côté serveur, jamais dans le code public du navigateur.