> 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/power-bi-api.md).

# API des plans publiés

## Vue d'ensemble

Ce point de terminaison donne accès aux plans publiés d'un projet, ce qui peut être un moyen puissant d'établir une routine de reporting basée sur une « cadence » (par exemple, comparer les performances de la semaine dernière à celles de la semaine précédente) ou d'extraire et de stocker des données historiques de planification.

En accédant aux plans publiés, vous pouvez vous assurer que toute mesure des données repose sur des plans examinés et approuvés par l'équipe projet.

Les cas d'utilisation les plus courants de ce point de terminaison sont ;

* connexion aux modèles Power BI fournis par Aphex.
* connexion à Excel ou Power BI pour créer des rapports sur mesure pour un projet ou une série de projets.
* consommation et stockage via une opération ETL sur un ou plusieurs projets au sein d'un portefeuille.

L'API Power BI comporte trois composants.

* [Authentification](#authentication)
* Paramètres de requête
* Modèle de données

{% hint style="success" %}

## Configuration de Power BI

Si vous cherchez le guide rapide pour configurer Power BI pour votre projet, [consultez ce guide ici](/docs/aphex-help-fr/integrations-et-api/power-bi/getting-started-with-power-bi-reporting.md)
{% endhint %}

## Authentification <a href="#authentication" id="authentication"></a>

Vous pouvez accéder à l'API en interrogeant l'URL du point de terminaison pour le projet souhaité et en fournissant un jeton valide.

#### Trouver votre URL d'API <a href="#h_c800d3e210" id="h_c800d3e210"></a>

En tant qu'administrateur de projet, rendez-vous sur votre projet dans l'application Aphex Planner. Depuis la page Intégrations, l'API peut être activée.

Cela révélera l'URL de l'API spécifique à ce projet. La structure de l'URL sera la suivante :

```
https://app.aphex.co/power-bi/v1/<your_api_account_id>
```

#### Génération des jetons <a href="#h_7675b98a0b" id="h_7675b98a0b"></a>

Depuis le même emplacement où vous avez récupéré l'URL de l'API, un nouveau jeton peut être créé. Créez un nouveau jeton et nommez-le, par exemple : `Jeton de tableau de bord du projet 1`

#### Jeton secret <a href="#h_c5074b6a65" id="h_c5074b6a65"></a>

Vous ne pouvez pas récupérer le jeton plus tard, vous devez donc le stocker dans un gestionnaire de secrets. Si vous perdez le jeton, vous pouvez en générer un nouveau.

#### Interroger l'API <a href="#h_7ac3640b01" id="h_7ac3640b01"></a>

Pour authentifier correctement votre requête auprès de l'URL de l'API, définissez le jeton dans l'en-tête `Authorization` de la requête.

Cela peut se faire de trois façons ;

1. Si vous utilisez un **modèle Power BI Aphex**, il suffit de coller l'URL et le jeton dans la fenêtre modale de configuration

<figure><img src="https://downloads.intercomcdn.com/i/o/661987570/71d7bd55de3ad36acddb97c5/Aphex+Power+BI+Setup+-+Aphex+Template.png" alt=""><figcaption></figcaption></figure>

2. Si vous générez votre **votre propre** rapport dans Power BI, configurez une nouvelle source "**Web**" source. Dans le menu Avancé, saisissez l'URL et la clé d'en-tête de requête de `Authorization` avec `Bearer` suivi de votre jeton comme valeur.

<figure><img src="https://downloads.intercomcdn.com/i/o/661988421/faa34f5fa56240785b5a030b/Aphex+Poer+BI+Setup+-+Custom+Report.png" alt=""><figcaption></figcaption></figure>

3. Si vous consommez les données dans **tout autre service** construisez une requête cURL valide (exemple ci-dessous).

```
curl \\
 -X GET \\
 -H "Authorization: Bearer $<your_token>" \\
 https://app.aphex.co/power-bi/v1/<your_API_account_id_here>
```

## Paramètres de requête <a href="#parameters" id="parameters"></a>

Les paramètres de requête vous permettent d'ajuster le contenu de la réponse. Pour permettre à des projets de tailles variées de tirer le meilleur parti de cette API dans la limite de réponse unique de 32 Mo, les paramètres de requête suivants sont pris en charge ;

| Paramètre                                            | Description                                                                                                                                                                             |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>Limite</p><p><code>limit=number</code></p>        | Ce paramètre déterminera combien de versions publiées historiques sont renvoyées. S'il n'est pas fourni, la réponse prendra par défaut `5`                                              |
| <p>Statut</p><p><code>status=boolean</code></p>      | Ce paramètre déterminera si les événements de statut sont inclus dans la réponse. S'il n'est pas fourni, la réponse prendra par défaut `true`                                           |
| <p>Ressource</p><p><code>resource=boolean</code></p> | Ce paramètre déterminera si les affectations de main-d'œuvre, d'équipement et de matériel sont incluses dans la réponse. S'il n'est pas fourni, la réponse prendra par défaut `true`    |
| <p>Bloqueurs<br><code>blockers=boolean</code></p>    | Ce paramètre déterminera si les bloqueurs sont inclus dans la réponse. S'il n'est pas fourni, la réponse prendra par défaut `true`                                                      |
| <p>Production<br><code>production=boolean</code></p> | Ce paramètre déterminera si les mesures de production et le détail journalier de la production sont inclus dans la réponse. S'il n'est pas fourni, la réponse prendra par défaut `true` |

{% hint style="info" %}
Remarque : pour permettre des réponses supérieures à 32 Mo, veuillez vous renseigner sur un plan Enterprise.
{% endhint %}

## Modèle de données <a href="#data-model" id="data-model"></a>

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 Power BI contient les objets suivants ;

<details>

<summary>Publications</summary>

Les publications sont incluses dans la fenêtre de réponse. Par défaut, l'API renverra jusqu'aux cinq publications les plus récentes.

**Réponse**

* Nom de la publication
* ID de publication
* Date de publication<br>

</details>

<details>

<summary>Résumés des publications</summary>

La répartition des responsables pour chaque publication montre l'état de préparation et les données associées

**Réponse**

* Nom du responsable
* E-mail du responsable
* État de préparation
* Date de préparation
* Champs manquants
* Conflits
* Bloqueurs en retard

</details>

<details>

<summary>Tâches</summary>

Les tâches uniques incluses dans la réponse

**Réponse**

* ID de tâche
* Nom du projet
* ID du projet

</details>

<details>

<summary>Version de la tâche</summary>

Les versions des tâches incluses dans chacune des publications, ainsi que toutes les propriétés de la tâche.

**Réponse**

* ID de tâche
* ID de publication
* Nom de la tâche
* Début
* Fin
* Durée
* Calendrier
* Quart
* Nom du responsable
* E-mail du responsable
* Sous-traitant
* ID de zone de travail
* Nom du lieu
* Type de lieu
* Chemin WBS
* Nom WBS
* ID externe
* Code paquet
* Nom du paquet
* ID parent
* Jalon \*
* Statut
* Notes
* Bloqueurs
* E-mails des assignés
* Noms des assignés
* Étiquettes
* Date cible
* ID de mesure de production \*\*
* Nom de la mesure de production \*\*
* Unité de production \*\*
* Nom de l'unité de production \*\*
* Quantité totale de production \*\*
* Taux cible de production \*\*
* Pourcentage d'avancement de la production \*\*
* À risque \*\*
* Production en retard sur le rythme \*\*

\**Les jalons apparaîtront comme Tâche clé \[true / false] dans la réponse*

*\*\*Les champs de production apparaissent uniquement sur les tâches avec une mesure de production. Lorsqu'un champ ne s'applique pas, il est omis de la réponse plutôt que renvoyé vide. ProductionPercentComplete est une valeur de 0 à 100*

</details>

<details>

<summary>Statut</summary>

Tous les événements de statut sur chacune des tâches à chacune des publications

**Réponse**

* ID de tâche
* ID de publication
* Date
* Montant
* Type de statut
* Raison
* Créé le
* Nom du créateur
* E-mail du créateur
* Production du jour \*
* Production en retard sur le rythme \* \*\*
* Quantité cumulée de production \*
* Pourcentage cumulé de production \*

\**\*\*Les champs de production apparaissent uniquement sur les tâches avec une mesure de production. Lorsqu'un champ ne s'applique pas, il est omis de la réponse plutôt que renvoyé vide. ProductionCumulativePercent est une fraction, par exemple 0,42 pour 42 %.*

*\*\*Un jour marqué comme `ProductionBehindPace` peut toujours être enregistré comme étant dans les délais, donc les rapports qui l'excluent sur la base du type de statut ou du motif le manqueront. Il est recommandé de filtrer directement sur `ProductionBehindPace` directement.*

</details>

<details>

<summary>Ressources de main-d'œuvre</summary>

Toute la main-d'œuvre affectée à chacune des tâches à chacune des publications

**Réponse**

* ID de tâche
* Date
* ID de publication
* ID de ressource
* Nom de la ressource
* Quantité planifiée de la ressource

</details>

<details>

<summary>Ressources d'équipement</summary>

Tout l'équipement affecté à chacune des tâches à chacune des publications

**Réponse**

* ID de tâche
* Date
* ID de publication
* ID de ressource
* Nom de la ressource
* Catégorie de ressource
* Quantité planifiée de la ressource

</details>

<details>

<summary>Ressources matérielles</summary>

Tous les matériaux affectés à chacune des tâches à chacune des publications

**Réponse**

* ID de tâche
* Date
* ID de publication
* ID de ressource
* Nom de la ressource
* Quantité planifiée de la ressource
* Quantité réelle de la ressource
* Unité de la ressource

</details>

<details>

<summary>Bloqueurs</summary>

Tous les bloqueurs affectés à chacune des tâches à chacune des publications

**Réponse**

* ID de tâche
* Date d'échéance du bloqueur
* ID de publication
* ID du bloqueur
* Nom du bloqueur
* Catégorie du bloqueur
* Statut du bloqueur
* Date de résolution du bloqueur

</details>

<details>

<summary>Mesures de production</summary>

Toutes les mesures de production publiées à chacune des publications

**Réponse**

* ID de la mesure de production
* Nom
* Unité
* Nom de l'unité
* Activation du taux cible
* Valeur du taux cible
* Nombre de tâches
* ID de publication

UnitName et TargetRateValue sont omis de la réponse lorsqu'ils ne sont pas définis

</details>

<details>

<summary>Répartition quotidienne de la production</summary>

La production planifiée et réelle de chacune des tâches, par jour, à chacune des publications

**Réponse**

* Date
* ID de tâche
* ID de la mesure de production
* Quantité planifiée
* Quantité réelle
* ID de publication

</details>

## Limites et restrictions <a href="#restrictions" id="restrictions"></a>

L'API Power BI 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 expliqué dans la [Authentification](#authentication) section, les requêtes vers 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'administration 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 que, dans le temps, les données du projet restent sécurisées par défaut. À l'expiration, ou à tout moment, de nouveaux jetons peuvent être générés pour le projet.
* Limites : pour rester dans les limites de l'infrastructure et éviter les réponses paginées sur ce point de terminaison, une limite de réponse de 32 Mo s'applique. Si vous rencontrez une erreur serveur, veuillez essayer de réduire votre demande de données en ajoutant des paramètres de requête. Il existe également une limite stricte d'historique des données de 6 mois.
* 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. Une utilisation du service en dehors de ce cadre, qui menacerait la disponibilité du service pour d'autres projets, pourrait entraîner la suspension du service pour le projet contrevenant.

{% hint style="info" %}
Remarque : pour permettre des réponses supérieures à 32 Mo, veuillez vous renseigner sur un plan Enterprise.
{% endhint %}


---

# 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/power-bi-api.md?ask=<question>&goal=<user_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.