Ouvrir un relevé sur myArquos

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

Sans cet appel préalable, l’utilisateur pourrait arriver sur une application sans relevé associé à l’équipement ciblé.

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

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

Paramètres de la requête (Body)

string

required

Identifiant unique de l’agence.

string

required

Numéro unique de l’équipement.

string

required

Email de l’utilisateur qui va réaliser le relevé (doit correspondre à son compte myArquos).

{
  "agency_id": "test_agency_01",
  "equipment_number": "ASC_45678",
  "user_email": "test+028910@arquos.eu"
}

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"
}'

{
  "status": "success",
  "response": {}
}

É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 :

myArquos://surveys

Relevé

Fiche équipement

Données équipements

Données clients

Statistiques

Données de référence

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

Endpoint & Authentification

Paramètres de la requête (Body)

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

Identifiants techniques

Format de l’URL de redirection

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

​Endpoint & Authentification

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

​Étape 2 : Lancement de l’application (Deep Link)

​Identifiants techniques

​Format de l’URL de redirection

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

Endpoint & Authentification

Paramètres de la requête (Body)

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

Identifiants techniques

Format de l’URL de redirection