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

# L'API REST

> Lire et agir dans Arquos depuis votre logiciel : équipements, clients, relevés, affaires, appels, devis, factures, import.

L'API REST d'Arquos V2 couvre tout ce que faisait l'API V1, et ce que la nouvelle version sait faire en plus. Chaque appel passe par **le même chemin que l'écran** : mêmes contrôles (champs obligatoires, valeurs admises), mêmes droits, et chaque écriture est tracée.

## L'essentiel

| | |
| :- | :- |
| Adresse | `https://api.arquos.eu/api/v2` |
| Authentification | `Authorization: Bearer <jeton d'API>` (voir [Authentification](/v2/authentification)) |
| Agence | en-tête `X-Arquos-Agency` facultatif (voir [Agence](/v2/agence)) |
| Format | JSON, en UTF-8. Les noms de champs et de paramètres sont en anglais ; les messages d'erreur et les codes de valeur (`ouverte`, `appel.clos`) restent en français |
| Limite | 120 appels par minute et par compte, puis `429` et l'en-tête `Retry-After` |
| Spécification | [`/api/v2/openapi.json`](https://api.arquos.eu/api/v2/openapi.json), OpenAPI 3.1, publique |

```bash theme={"system"}
curl https://api.arquos.eu/api/v2/me \
  -H "Authorization: Bearer arq_agent_VOTRE_JETON"
```

## Ce que l'API sait faire

* **Le parc** : équipements (avec toutes leurs données techniques, lues et corrigées), immeubles, clients, contacts.
* **Les relevés** : ceux d'un équipement, les données d'un relevé par composant (avec leur nom V1), ses photos (lues, déposées, rangées), ses documents PDF, et la création d'un relevé.
* **Les étages** d'un équipement, créés d'après son nombre de niveaux.
* **Le commerce** : affaires (création avec leurs relevés, statistiques), contrats et leurs variations de prix, devis, factures.
* **La maintenance** : appels en cours, ouverture et affectation d'un appel, visites dues, planning, techniciens, demandes de pièce.
* **Les écarts et réserves**, les notes, la recherche globale.
* **L'import** d'un tableau `.csv` ou `.xlsx`, vérifié avant d'écrire, tout ou rien.
* **Les webhooks** : Arquos prévient votre logiciel quand un appel est clos, un relevé soumis, un devis accepté (voir [Webhooks](/v2/webhooks)).

Le détail de chaque route est dans la **Référence**, générée depuis la spécification.

## Les listes

Une liste se lit par pages : `?limit=50&page=1` (200 au plus par page). Elle rend son `total`, la `page`, la `limit` et les `results`. Les listes du parc se cherchent avec `?q=` ; les écarts, contrats, devis et factures se filtrent par `statut`, `equipement` ou `client`, et par dates de création (`depuis`, `jusqua`, au format `AAAA-MM-JJ`).

## Les liens

Chaque objet rendu porte son `link` (le chemin de sa fiche) et son `url` complète : votre logiciel peut ouvrir la fiche dans Arquos d'un clic. C'est ce que faisaient `open_myarquos` et `generate_token` en V1.

## Les écritures

Une écriture (création, correction) rend `201` ou `200` avec l'identifiant et le lien de l'objet. Un refus rend `422` et sa raison en français ; un objet hors de vos agences, `404`. Rien n'est écrit à moitié : une correction de plusieurs données techniques passe en entier ou pas du tout, comme un import.

## Depuis la V1

| V1 | V2 |
| :- | :- |
| `get_equipment_data` | `GET /equipment/{id}` (et `GET /equipment?q=` pour trouver l'identifiant par numéro) |
| `update_equipment_data` | `PATCH /equipment/{id}` |
| `get_client` | `GET /clients/{id}`, `GET /clients?q=` |
| `update_client` | `PATCH /clients/{id}`, `POST /clients` |
| `create_survey` | `POST /surveys`, ou `POST /deals` pour une affaire et ses relevés |
| `open_myarquos`, `generate_token` | le `link` et l'`url` de chaque réponse |
| `get_opportunities_stats` | `GET /deals/stats` |
| `get_brands` | `GET /brands` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.