> For the complete documentation index, see [llms.txt](https://help.aphex.co/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aphex.co/docs/aphex-help-fr/integrations-et-api/api/work-area-api.md).
# API de la zone de travail
{% hint style="warning" %}
Cette fonctionnalité est disponible uniquement avec les formules Pro+ ou Enterprise
{% endhint %}
## Vue d'ensemble
Ce point de terminaison donne accès aux zones de travail des plans publiés pour un projet.
Les équipes qui génèrent des plans en utilisant les emplacements Map Space produisent un jeu de données unique associé de zones de travail réelles et de tâches planifiées. Les équipes peuvent utiliser ces données de localisation dans n’importe lequel de leurs outils externes de SIG ou d’analyse avec l’API Work Area.
L’API Work Area comporte trois composants.
* [Authentification](#h_1cc09f10c5)
* [Modèle de données](#h_9a7e69599f)
* [Limites et restrictions](#h_61d6b266e4)
## Authentification
Vous pouvez accéder à l’API Work Area en interrogeant l’URL du point de terminaison pour le projet souhaité et en fournissant un jeton valide.
Trouver votre URL d’API
En tant qu’administrateur du projet, rendez-vous sur votre projet dans l’application Aphex Planner. Depuis la page Intégrations, l’API peut être activée.
Cela fera apparaître l’URL de l’API spécifique à ce projet. La structure de l’URL sera la suivante ;
```
https://app.aphex.co/work-areas/v1/
```
#### Génération de jetons
Depuis le même emplacement où vous avez récupéré l’URL de l’API, un nouveau jeton peut être créé.
{% hint style="danger" %}
#### Jeton secret
Vous ne pouvez pas récupérer le jeton ultérieurement, alors veillez à le stocker dans un gestionnaire de secrets. Si vous perdez le jeton, vous pouvez en générer un nouveau.
{% endhint %}
#### Interroger l’API
Pour authentifier correctement votre requête auprès de l’API, définissez le jeton dans la chaîne de requête de l’URL.
L’exemple ci-dessous peut être utilisé en remplaçant l’ID du compte API et le jeton par ceux récupérés à l’étape précédente
```
https://app.aphex.co/work-areas/v1//t/
```
## Modèle de données
Les requêtes valides vers l’API renverront une réponse JSON conforme au modèle de données de l’API.
Le modèle de données de l’API Work Area contient les objets suivants ;
| Objet | Exemple |
| --------------------------- | ------------------------------------------- |
| ID de zone de travail | `HEntifOafSu297hg3oj8.2IPGEecKYBdwrpxcwXCX` |
| Nom de l’emplacement | `Site principal` |
| Type d’emplacement | `Map Space` |
| ID de tâche | `2IPGEecKYBdwrpxcwXCX` |
| Nom de la tâche | `Construire un mur` |
| Début | `2022-06-13 00:00:00+00:00` |
| Fin | `2022-06-14 00:00:00+00:00` |
| Durée | `2` |
| Maj | `jour` |
| Nom affiché du propriétaire | `Bruce Wayne` |
| E-mail du propriétaire | `bruce@wayneindustries.com` |
| Sous-traitant | `Batman Ltd` |
| Chemin WBS | `12.2.3` |
| Nom WBS | `Usines` |
| ID externe | `Aiw9123` |
| Code du lot | `W-203` |
| Nom du package | `Internes` |
| ID de tâche | `2IPGEecKYBdwrpxcwXCX` |
| Tâche clé | `Faux` |
| Statut | `Planifié` |
| Notes | `Accès à la grue à 10 h` |
## Limites et restrictions
L’API Work Area comporte un petit nombre de restrictions et de limites afin de garantir la disponibilité du système et la sécurité des données clients.
* **Restrictions de gestion des jetons**: Comme indiqué dans la section Authentification, les requêtes à l’API ne réussiront que si elles respectent la structure de requête correcte et incluent à la fois une URL valide et un jeton. Les jetons sont générés individuellement pour un projet, par un utilisateur disposant des droits d’administrateur du projet.
* **Limites de validité des jetons**: Les jetons générés ont une durée de vie maximale de 3 mois afin de garantir qu’au fil du temps, les données du projet sont sécurisées par défaut. À l’expiration, ou à tout moment, de nouveaux jetons peuvent être générés pour le projet.
* **Limite de publication**: Afin de maintenir la disponibilité du système, une limite de publication existe pour l’API Work Area. Les requêtes API réussies renverront jusqu’à un maximum de cinq (5) des publications de données les plus récentes.
* **Politique d’utilisation équitable**: Le point de terminaison de l’API est conçu pour prendre en charge des requêtes périodiques (généralement hebdomadaires) provenant des projets. Toute utilisation du service en dehors de ce cadre, susceptible de menacer la disponibilité du service pour les autres projets, pourrait entraîner une suspension du service pour le projet fautif.
---
# 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 by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://help.aphex.co/docs/aphex-help-fr/integrations-et-api/api/work-area-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.