Obtention de l'URI-URL du fichier
Présentation générale de l'API et finalité fonctionnelle
Cette API permet d’obtenir le lieu de stockage du document à traiter, dès lors que l’utilisation de l’Azure Storage mis à disposition par Cegid Loop est utilisé :
Cette API renvoie :
Une URL authentifiée permettant de déposer par la méthode http "PUT" le fichier d’écritures à importer dans Cegid Loop.
Une URI correspondant au chemin relatif du fichier déposé. Celle-ci est à renseigner dans l’appel de l’import d’écritures pour les formats TRA, FEC et personnalisé.
Procédure
Il faut appeler un endpoint permettant d'enregistrer une demande de récupération du lieu de stockage du document à traiter :
Route | Méthode http | Description |
---|---|---|
/getFileUrlDeposit | GET | Récupération du lieu de stockage du document |
Paramétrage de l'appel
Méthode http pour la demande : GET
Header(s) attendu(s) obligatoire(s) de la demande : API-KEY
Structure de la requête de la demande
Clé | Type | Description |
---|---|---|
filename | String | Nom du fichier avec extension |
Exemple : /getFileUrlDeposit?filename=fichier.xxx (avec xxx=tra ou txt ou csv)
Les différents codes retours en cas de succès
Code retour http de la réponse : 200
Format corps de la réponse : JSON
Structure du corps de la réponse dans le cas d'une URL authentifiée :
Clé | Type | Valeur |
---|---|---|
depositUrl | String | URL authentifiée permettant de déposer par la méthode http "PUT" votre fichier d'écritures à importer dans le stockage Azure, mis à disposition par Cegid Loop |
{
\"depositUrl\": \"
\"https://looptestcabinetrdd.blob.core.windows.net\...\"
}
Structure du corps de la réponse dans le cas d'une uri :
Clé | Type | Valeur |
---|---|---|
uri | String | Chemin relatif du fichier déposé et à renseigner dans l'appel API de l'import d'écritures (TRA, FEC et personnalisé) une fois le dépôt effectué |
{
\"uri\": \"142ae28e-bb2e-4a1d-a8a1-17d59e55b7ca/fichier.xxx"
}