# Comment utiliser l'API pour créer un nouveau rapport

#### Champs de configuration

Le tableau ci-dessous décrit tous les champs configurables lors de la création d'un nouveau rapport via l'API. 

*⚠️ Les champs et valeurs avec \* sont disponibles uniquement pour la solution ACM*

<table data-header-hidden><thead><tr><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Étiquette</strong></td><td><strong>Description</strong></td><td><strong>Valeurs possibles</strong></td><td><strong>Exemple Didomi</strong></td></tr><tr><td>name</td><td>Nom du rapport tel qu'il apparaît dans la console Didomi</td><td>string</td><td>Didomi France</td></tr><tr><td>website</td><td>Le site web à scanner</td><td>url commençant par https://</td><td>https://www.didomi.io/</td></tr><tr><td>country</td><td>Le pays depuis lequel le scan sera exécuté</td><td>fr<br>de<br>gb<br>us<br>es<br>be<br>br</td><td>fr</td></tr><tr><td>schedule</td><td>Expression Cron décrivant la fréquence d'exécution du rapport</td><td><em>quotidien * : 0 0 * * *</em><br><em>hebdomadaire * : 0 0 * * 0</em> <br>mensuel : 0 0 1 * *<br>exécution unique : null</td><td>0 0 1 * *</td></tr><tr><td>pages_count</td><td>Nombre de pages à scanner</td><td>int &#x3C;= 20</td><td>10</td></tr><tr><td>filters</td><td>Un filtre sur les pages qui seront scannées. Peut utiliser une chaîne (ex. "/products" scannera uniquement les URL contenant /products) ou une expression régulière (ex. ^p scannera toutes les URL commençant par p)</td><td><pre><code>{
  "type": "string",
  "value": "string"
} 
</code></pre><pre><code>{
"type": "regex",
"value": "string"
} 
</code></pre></td><td><pre><code>{

"type": "string",

"value": "products"

}  </code></pre><p> </p></td></tr><tr><td>scenarios \*</td><td>Un tableau des scénarios que nous exécuterons et des actions personnalisées qui y sont associées. </td><td><pre><code>\[{
"enabled": true,
"type": "accept\_all",
"scenario\_actions": \[
{
"type": "accept",
"order": 0
}
]
},

{
"enabled": true,
"type": "refuse\_all",
"scenario\_actions": \[
{
"type": "refuse",
"order": 0
}
]
},
{
"enabled": true,
"type": "no\_actions",
"scenario\_actions": \[]
}
] </code></pre></td><td><p> </p><pre><code>
\[{
"enabled": true,
"type": "accept\_all",
"scenario\_actions": \[
{
"type": "accept",
"order": 0
}
]
},

{
"enabled": true,
"type": "refuse\_all",
"scenario\_actions": \[
{
"type": "refuse",
"order": 0
}
]
},
{
"enabled": true,
"type": "no\_actions",
"scenario\_actions": \[]
}
] </code></pre><p> </p><p> </p></td></tr><tr><td><em>user\_agent \*</em></td><td>Agent utilisateur que le bot utilisera lors du scan. </td><td>string</td><td>"my\_custom\_user\_agent"</td></tr><tr><td><em>login \*</em></td><td>Identifiants et paramètres pour exécuter un scan dans un environnement connecté</td><td><pre><code>{
"enabled": true,
"selectors": {
"pathToForm": "string",
"usernameField": "string",
"passwordField": "string",
"submitButton": "string"
},
"credentials": {
"username": "string",
"password": "string"
} </code></pre></td><td><pre><code>{
"enabled": true,
"selectors": {
"pathToForm": "login.mywebsite.com"
},
"credentials": {
"username": "my\_username",
"password": "my\_password"
} </code></pre></td></tr></tbody></table>

&#x20;

#### Exemple pour rapport de conformité standard

Cet exemple peut aussi être utilisé comme modèle.

```
[
  {
    "name": "Didomi France",
    "website": "https://www.didomi.io/",
    "schedule": "0 0 * * *",
    "url": "https://www.didomi.io/",
    "pages_count": 10,
    "country": "fr",
    "enabled": true,
  }
]
```

#### Exemple pour rapport de conformité ACM

Cet exemple peut aussi être utilisé comme modèle.

```
[
    {
        "name": "Didomi France",
        "website": "https://www.didomi.io/",
        "country": "fr",
        "pages_count": 10,
        "enabled": "true",
        "filters":[{
            "type": "string",
            "value": "products"

        }],
        "schedule": "0 0 * * *",
        "userAgent": "my_custom_user_agent",
        "login":  
        {
            "enabled": true,
            "selectors":
            {
                "pathToForm": "login.mywebsite.com"
            },
            "credentials":
            {
                "username": "my_username",
                "password": "my_password"
            }
        },
        "scenarios":
        [
            {
                "enabled": true,
                "type": "accept_all",
                "scenario_actions":
                [
                    {
                        "type": "accept",
                        "order": 0
                    }
                ]
            },
            {
                "enabled": true,
                "type": "refuse_all",
                "scenario_actions":
                [
                    {
                        "type": "refuse",
                        "order": 0
                    }
                ]
            },
            {
                "enabled": true,
                "type": "no_actions",
                "scenario_actions":
                []
            }
        ]
    }
]
```

#### Utilisation de l'API

Une documentation plus détaillée sur l'utilisation de l'API Didomi est disponible [ici](https://developers.didomi.io/api/introduction)

Lors de la création du payload de la requête, vous pouvez ajouter une ou plusieurs propriétés en même temps. Le payload attendu est un tableau qui peut contenir une ou plusieurs propriétés à insérer.&#x20;

#### Endpoint

Le endpoint à utiliser est&#x20;

```
https://api.didomi.io/reports/compliances/properties?organization_id=<organization_id>
```

Veuillez vous assurer de remplacer \<organization\_id> par l'identifiant de votre organisation.


---

# Agent Instructions: 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:

```
GET https://docs.didomi.io/fr/surveillance-avancee-de-la-conformite-acm/rapport-de-conformite-acm/comment-utiliser-lapi-pour-creer-un-nouveau-rapport.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.