Skip to main content

É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éthodeURL
POSThttps://app.arquos.eu/api/1.1/wf/open_myarquos
En-têtes (Headers) :
  • Authorization: Bearer [VOTRE_API_KEY]
  • Content-Type: application/json

Paramètres de la requête (Body)

agency_id
string
required
Identifiant unique de l’agence.
equipment_number
string
required
Numéro unique de l’équipement.
user_email
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": "[email protected]" 
}
{
  "status": "success",
  "response": {}
}
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ètreValeur
Custom URI SchememyArquos://
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://cases