Créer un compte expéditeur via l'API

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 (en partie 2)
• 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 token
• firstname : le nom de famille de la personne physique rattachée au compte
• lastname : le prénom de la personne physique rattachée au compte
• email : l’adresse email de l’utilisateur. Elle doit être accessible afin de valider le compte
• gender : la civilité de l’utilisateur
• statut : le statut de l’utilisateur (« particulier », « professionnel », « administration » ou « association »). Permettra de définir le délai de facturation (quotidien ou mensuel)
• address1 : l’adresse de l’utilisateur
• city : la ville de l’utilisateur
• zipcode : le code postal de l’utilisateur
• country : le pays de l’utilisateur
• company_siret (Uniquement obligatoire si le pays de l’utilisateur est situé en France et DOM TOM et si le statut est professionnel ou administration) : le SIRET de la société de l’utilisateur (dans le cas d’un compte professionnel)
• company_tva (Uniquement obligatoire si le pays de l’utilisateur est situé en Europe et si le statut est professionnel ou administration) : la TVA de la société de l’utilisateur (dans le cas d’un compte professionnel)

Des paramètres optionnels sont disponibles :

• address2 : un complément d’adresse de l’utilisateur
• company : la raison sociale de l’entreprise 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’utilisateur
• billing_email : ajouter une adresse email supplémentaire qui recevra les factures émises pour le compte
• confirmed : 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’utilisateur
• notify_ar : envoyer ou non par email les preuves d’AR des recommandés de l’utilisateur
• notify_rf : envoyer ou non par email les preuves de refus des recommandés de l’utilisateur
• notify_ng : envoyer ou non par email les preuves de négligence des recommandés de l’utilisateur
• notify_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 validation
• notify_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://developers.ar24.fr/doc/#post-create-user

Si l’erreur retournée correspond au slug user_already_exist, lisez notre procédure de rattachement d’un utilisateur existant à votre API (en partie 2).

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 token
• email : 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://developers.ar24.fr/doc/#post-send-access-confirmation-mail