ID Mobile — Documents de facturation avec consentement

Support DQE
Support DQE
  • Mise à jour

Utilisez ce point de terminaison pour récupérer un justificatif de facturation ou de domicile auprès de l'opérateur, avec le consentement de l'utilisateur. Le processus se déroule en deux étapes : lancer la demande de consentement, puis récupérer le document.

Documentation ID Mobile associée :

Étape 1 — Lancer la demande de consentement

Requête GET

https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&scope=billing&redirect_uri={URL_REDIRECT}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Description Obligatoire/Optionnel
SERVER_ADDRESS Adresse du serveur DQE qui traitera les données. Obligatoire
licence Numéro qui vous a été attribué comme code de licence. Obligatoire
number Numéro de téléphone. Obligatoire
token Token récupéré lors de l'authentification. Obligatoire
mode 2 : authentification par code. Obligatoire
name Nom du partenaire dans la base de données DQE Software, généralement le nom de votre entreprise. Obligatoire
code_name Champ optionnel contenant un code associé à name. Optionnel
scope Valeur statique. Doit être billing pour ce scope. Obligatoire
redirect_uri URL de redirection. DQE ajoute le token de session et le statut à la redirection. Optionnel

Requête POST

https://{SERVER_ADDRESS}/IDMOBILE/

Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded :

Paramètre Description Obligatoire/Optionnel
licence Numéro qui vous a été attribué comme code de licence. Obligatoire
number Numéro de téléphone. Obligatoire
token Token récupéré lors de l'authentification. Obligatoire
mode 2 : authentification par code. Obligatoire
name Nom du partenaire dans la base de données DQE, généralement le nom de votre entreprise. Obligatoire
code_name Champ optionnel contenant un code associé à name. Optionnel
scope Valeur statique. Doit être billing pour ce scope. Obligatoire
redirect_uri URL de redirection. DQE ajoute le token de session et le statut à la redirection. Optionnel

Réponse

Succès

Clé Description Type
status success : informations récupérées avec succès. STRING
scope billing STRING
billing Justificatif de domicile encodé en Base64. STRING

Exemple :

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

En attente

Clé Description Type
status pending : DQE attend la réponse de l'opérateur. STRING
scope billing STRING

Exemple :

{
  "status": "pending",
  "scope": "billing"
}

Erreur

ID d'erreur Type d'erreur Description
01 invalid request La requête n'est pas valide.
02 invalid licence key La licence n'est pas valide.
04 invalid scope Le scope n'est pas valide.
18 failed to retrieve data from operator Aucune donnée n'a été reçue après validation de l'OTP.
20 OTP incorrect La validation OTP n'a pas été effectuée.
21 access denied La validation OTP a été refusée.
30 invalid or expired token Le token a expiré.
99 internal server error Erreur serveur.

Étape 2 — Récupérer le document de facturation

Requête GET

https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=client_idmobile
Paramètre Description Obligatoire/Optionnel
SERVER_ADDRESS Adresse du serveur DQE qui traitera les données. Obligatoire
Licence Numéro qui vous a été attribué comme code de licence. Obligatoire
token Token récupéré lors de l'authentification. Obligatoire
scope Valeur statique. Doit être client_idmobile pour ce scope. Obligatoire

Requête POST

https://{SERVER_ADDRESS}/GET/

Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded :

Paramètre Description Obligatoire/Optionnel
Licence Numéro qui vous a été attribué comme code de licence. Obligatoire
token Token récupéré lors de l'authentification. Obligatoire
scope Valeur statique. Doit être client_idmobile pour ce scope. Obligatoire

Réponse

Succès

Clé Description Type
status success : document récupéré avec succès. STRING
scope billing STRING
billing Justificatif de domicile encodé en Base64. STRING

Exemple :

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

En attente

Clé Description Type
status pending : DQE attend la réponse de l'opérateur. STRING
scope billing STRING

Erreur

ID d'erreur Type d'erreur Description
01 invalid request La requête n'est pas valide.
02 invalid licence key La licence n'est pas valide.
04 invalid scope Le scope n'est pas valide.
18 failed to retrieve data from operator Aucune donnée n'a été reçue après validation de l'OTP.
20 OTP incorrect La validation OTP n'a pas été effectuée.
21 access denied La validation OTP a été refusée.
30 invalid or expired token Le token a expiré.
99 internal server error Erreur serveur.

Exemple :

{
  "status": "error",
  "error_type": "internal server error",
  "error_id": "99"
}

Voir aussi

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0