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.

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 :

Des paramètres optionnels sont disponibles :

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.

Le nouvel utilisateur devra accepter les CGU d’AR24. Vous pouvez envoyer à l’utilisateur un mail lui permettant d’accepter les CGU via la route /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 :

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

Afin d’éviter à votre client de rentrer des informations pour un compte déjà existant, il est conseillé d’appeler la route /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.
Vous ne trouvez pas votre réponse ? Contactez nous