Chaque expéditeur d’une lettre recommandée doit posséder un compte AR24.
Nous allons aborder la création d’un compte AR24 pour un nouvel utilisateur.
- Si votre client possède déjà un compte AR24, lisez notre procédure de rattachement d’un utilisateur existant à votre API
- Si vous souhaitez mettre en place le moyen de paiement de votre utilisateur, lisez notre procédure sur la mise en place de la facturation pour un utilisateur par l’API
1. Créer l’utilisateur via la route /user/
Vous avez la possibilité de créer des nouveaux utilisateurs via la route /user/
.
Les paramètres attendus sont les suivants :
token
: votre tokenfirstname
: le nom de famille de la personne physique rattachée au comptelastname
: le prénom de la personne physique rattachée au compteemail
: l’adresse email de l’utilisateur. Elle doit être accessible afin de valider le comptegender
: la civilité de l’utilisateurstatut
: le statut de l’utilisateur (particulier ou professionnel). Permettra de définir le délai de facturation (quotidien ou mensuel)address1
: l’adresse de l’utilisateurcity
: la ville de l’utilisateurzipcode
: le code postal de l’utilisateurcountry
: le pays de l’utilisateur
Des paramètres optionnels sont disponibles :
address2
: un complément d’adresse de l’utilisateurcompany
: la raison sociale de l’entreprise de l’utilisateur (dans le cas d’un compte professionnel)company_siret
: le SIRET de la société de l’utilisateur (dans le cas d’un compte professionnel)company_tva
: la TVA de la société de l’utilisateur (dans le cas d’un compte professionnel)is_legal_entity
: Faire des envois au nom de la société (si aucun nom de société n’est renseigné, le nom et prénom de l’utilisateur apparaîtront)notif_billing
: envoyer ou non la facture des envois de l’utilisateurbilling_email
: ajouter une adresse email supplémentaire qui recevra les factures émises pour le compteconfirmed
: forcer la confirmation du compte ou non (envoyer un mail pour vérifier l’adresse email du compte)notify_ev
: envoyer ou non par email les preuves d’envoi des recommandés de l’utilisateurnotify_ar
: envoyer ou non par email les preuves d’AR des recommandés de l’utilisateurnotify_rf
: envoyer ou non par email les preuves de refus des recommandés de l’utilisateurnotify_ng
: envoyer ou non par email les preuves de négligence des recommandés de l’utilisateurnotify_eidas_to_valid
: envoyer ou non par email la liste des recommandés eIDAS rédigés par l’équipe qui sont en attente de validationnotify_waiting_ar_answer
: envoyer ou non par email de façon bi-hebdomadaire la liste des recommandés envoyés par l’utilisateur qui sont en attente de lecture par ses destinataires
Vous obtenez alors un retour de notre API avec le statut SUCCESS
et les informations du compte nouvellement créé (notamment l’identifiant du nouveau compte AR24). Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://www.ar24.fr/documentation/api/#api-ErrorGroup-list
Si l’erreur retournée correspond au slug user_already_exist
, lisez notre procédure de rattachement d’un utilisateur existant à votre API.
/user/request_cgu
.Vous pouvez intégrer directement les CGU d’AR24 sur votre plateforme et ainsi créer des utilisateurs via l’API avec les CGU déjà acceptées pour ceux-ci. Contactez-nous pour mettre ce paramétrage en place sur votre token.
Une fois le compte utilisateur créé via l’API, lisez notre procédure sur la mise en place de la facturation pour un utilisateur par l’API ou encore la procédure de vérification d’identité de l’expéditeur pour effectuer des envois eIDAS via l’API
2. Rattacher un compte AR24 existant à votre API
Si lors de la création du compte vous obtenez l’erreur A user with the same email address already exists, c’est que votre client possède déjà un compte sur AR24 avec cette adresse email. Vous devez donc effectuer une demande de rattachement à ce compte via la route /user/request_access
:
Les paramètres attendus sont les suivants :
token
: votre tokenemail
: l’adresse email de l’utilisateur que vous souhaitez administrer via l’API
Vous obtenez alors un retour de notre API avec le statut SUCCESS
et l’utilisateur AR24 recevra un mail de notre part pour accepter la demande de rattachement à votre API. Libre à lui d’accepter ou non cette demande. Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://www.ar24.fr/documentation/api/#api-ErrorGroup-list
/user/request_access
et, en fonction du retour proposer ou non une inscription.En effet, si vous obtenez un statut
SUCCESS
c’est que votre client possédait déjà un compte AR24 et qu’il n’a pas besoin de faire d’inscription. Sinon, vous pourrez effectuer la procédure de création de compte.