> ## 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.

# Ouvrir un relevé sur myArquos

> Cette fonctionnalité permet de transférer un utilisateur vers l'application mobile native pour réaliser un relevé sur un équipement ciblé. Ce processus s'effectue en deux étapes.

### Étape 1 : Préparation du relevé (API)

Avant d'ouvrir l'application mobile, cet endpoint permet à Arquos de créer le relevé si nécessaire et d'associer l'utilisateur au contexte de l'équipement.

<Info>
  Sans cet appel préalable, l'utilisateur pourrait arriver sur une application sans relevé associé à l'équipement ciblé.
</Info>

### Endpoint & Authentification

| Méthode | URL                                              |
| :------ | :----------------------------------------------- |
| `POST`  | `https://app.arquos.eu/api/1.1/wf/open_myarquos` |

**En-têtes (Headers) :**

* `x-api-key: [VOTRE_API_KEY]`
* `Content-Type: application/json`

<Note>
  La clé API est propre à chaque partenaire et n'est autorisée que sur les agences qui lui ont été attribuées. Un appel avec une clé invalide, ou visant une agence non autorisée, n'est pas exécuté.
</Note>

### Paramètres de la requête (Body)

<ParamField body="agency_id" type="string" required>
  Identifiant unique de l'agence.
</ParamField>

<ParamField body="equipment_number" type="string" required>
  Numéro unique de l'équipement.
</ParamField>

<ParamField body="user_email" type="string" required>
  Email de l'utilisateur qui va réaliser le relevé (doit correspondre à son compte myArquos).
</ParamField>

<RequestExample>
  ```json JSON theme={null}
  {
    "agency_id": "test_agency_01",
    "equipment_number": "ASC_45678",
    "user_email": "test+028910@arquos.eu"
  }
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://app.arquos.eu/api/1.1/wf/open_myarquos \
    --header 'x-api-key: VOTRE_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "agency_id": "test_agency_01",
    "equipment_number": "ASC_45678",
    "user_email": "test+028910@arquos.eu"
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "response": {}
  }
  ```
</ResponseExample>

### Étape 2 : Lancement de l'application (Deep Link)

Une fois le workflow initialisé avec succès, l'utilisateur peut être redirigé vers l'application native **myArquos**. Le système d'exploitation du smartphone utilisera les identifiants ci-dessous pour cibler la bonne application.

#### Identifiants techniques

Ces informations peuvent être utiles pour configurer les autorisations d'ouverture d'applications tierces :

| Paramètre                  | Valeur                   |
| :------------------------- | :----------------------- |
| **Custom URI Scheme**      | `myArquos://`            |
| **Package Name (Android)** | `com.arquosapp.myarquos` |
| **Bundle ID (iOS)**        | `com.arquosapp.myarquos` |

#### Format de l'URL de redirection

Pour ouvrir l'application directement sur la page principale, l'URL suivante peut être utilisée :

```text theme={null}
myArquos://surveys
```