Gestion des pièces jointes sur l’API

L’ajout des pièces jointes peut se faire de deux façons :

• En chargeant sur la plateforme AR24 un document déjà accessible en ligne via la route /api/attachment/download
• En chargeant sur la plateforme AR24 votre document stocké en local sur votre serveur via la route /api/attachment

Les documents chargés sont rattachés à un compte AR24 et possèdent un identifiant unique. Vous pouvez consulter tous les fichiers rattachés à un utilisateur via la route /api/user/attachment/.

Lors de la rédaction d’un courrier recommandé, vous pouvez ajouter des documents rattachés au compte expéditeur avec le paramètre attachment (tableau d’identifiant de documents). Ainsi vous pouvez réutiliser à tout moment des documents rattachés au compte expéditeur dans différents courriers recommandés

Les documents chargés sur l’API ne peuvent pas être supprimés par raison de sécurité. Tous les documents chargés depuis plus de 30 jours qui n’ont pas été utilisés dans un courrier recommandé sont automatiquement supprimés.

1. Charger un document depuis une URL

Vous avez la possibilité de charger un document via une URL avec la route /api/attachment/download

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : identifiant du compte AR24 auquel rattacher le document
• file_url : URL vers laquelle le document est accessible (assurez-vous qu’il s’agisse d’un lien accessible sans identification)
• file_name : Optionnel : Nom à donner au document qui va être chargé

Vous obtenez alors un retour de notre API avec le statut SUCCESS et l’identifiant du document nouvellement chargé (file_id). (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-upload-an-attachment-from-a-url

2. Charger un document présent sur votre serveur

Vous avez la possibilité de charger un document avec la route /api/attachment

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : identifiant du compte AR24 auquel rattacher le document
• file : champ de type file correspondant au fichier que vous allez charger

À titre d’exemple, vous pouvez charger un document en ligne de commande en effectuant la commande : curl -v -F id_user=[id_user] -F token=[token] -F file=@test.pdf https://sandbox.ar24.fr/api/attachment/

• Exemple de code en Windev
• Exemple de code en VB
• Exemple de code en PHP
• Exemple de code en JAVA
• Exemple de code en C#
• Via Postman, vous avez la possibilité de générer des exemples de code afin de vous aider dans votre développement

Vous obtenez alors un retour de notre API avec le statut SUCCESS et l’identifiant du document nouvellement chargé (file_id). (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-upload-an-attachment

3. Lister tous les documents rattachés à un utilisateur

Vous avez la possibilité de visualiser tous les documents rattachés à un compte AR24 via la route /api/user/attachment et ainsi récupérer les identifiants uniques que vous pourrez utiliser dans vos envois.

Les paramètres obligatoires attendus sont les suivants :

• token : votre token
• id_user : identifiant du compte AR24

Vous obtenez alors un retour de notre API avec le statut SUCCESS et la liste des documents rattachés à cet utilisateur. (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/#get-list-attachments-for-a-user

4. Ajouter une pièce jointe à un envoi de courrier recommandé électronique

Lors de l’envoi d’un courrier recommandé électronique, vous avez la possibilité d’ajouter jusqu’à 256Mo de pièce-jointes à votre pli. Vous devez, au préalable de l’envoi, charger les pièces-jointes sur AR24 pour les rattacher à un compte expéditeur du courrier (voir les parties 1 et 2)

Lors de l’appel à la route /api/mail, l’ajout de pièce-jointes s’effectue grâce au paramètre attachment.
Ce paramètre est un tableau d’identifiants de pièce-jointes.

Par exemple, l’expéditeur (paramètre id_user) a chargé les documents ayant comme identifiants : 123, 456 et 789.
Il pourra alors utiliser un ou plusieurs de ces documents comme pièce-jointe de son courrier recommandé électronique en ajoutant les paramètres suivants à son appel à /api/mail : attachment[0] avec comme valeur 123, attachment[1] avec comme valeur 456.