Ajouter un document via API

Le module Documents de Fairways Dette stocke tous vos documents. Vous pouvez ajouter des document via API.

 

Prérequis

 

Saisissez cette commande pour ajouter un fichier :

curl -XPOST -v --header 'X-App-Token: Account's API-TOKEN ' --header 'content-type: application/xml'  -d '

<upload xmlns="http://www.financeactive.com/schemas/documents/v1"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">   

<document>

<name>[Nom du fichier]</name>
      <type>[Code du type de document]</type>

<metas>
    <meta>
        <key>[Code de la métadonnée]</key>
        <value xsi:type="xs:[Type de la métadonnée]">[Valeur]</value>
    </meta>
    <meta>
        <key>[Code de la métadonnée]</key>
        <value xsi:type="xs:[Type de la métadonnée]">[Valeur]</value>
    </meta>
</metas>

<links>
       <link>
            <type>[Type de produit]</type>
            <id>[Référence externe du produit]</id>
        </link>
</links>

<content>
        [**Document en Base64**]
</content>

    </document>

</upload>

' '[Adresse URL de l'endpoint de la plateforme]'


 

 

Saisissez cette commande pour ajouter un document à partir d'une URL :

curl -XPOST -v --header 'X-App-Token: Account's API-TOKEN ' --header 'content-type: application/xml'  -d '

<upload xmlns="http://www.financeactive.com/schemas/documents/v1"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">   

<document>

<name>[Nom du fichier]</name>
      <type>[Code du type de document]</type>

<links>
       <link>
            <type>[Type de produit]</type>
            <id>[Référence externe du produit]</id>
        </link>
</links>

<url>[URL pointant vers le document]</doc>

    </document>

</upload>

' '[Adresse URL de l'endpoint de la plateforme]'


 

 

Exemple 1 : Ajout d'un fichier

Ajoutons ce document :

Nom du document

Test_doc.pdf

Type du document

Contrat

Référence externe du produit

123456

Métadonnées

  • Couleur : Or
  • Année : 2020
  • VIP (vrai/faux) : Vrai

 

  1. Créez un type de document avec le code Contrat.
  2. Créez 3 métadonnées :
    • Code : Couleur, Type : Text
    • Code : Annee, Type : Long
    • Code : VIP, Type : Boolean
  3. Saisissez cette commande :
curl -XPOST -v --header 'X-App-Token: Account's API-TOKEN ' --header 'content-type: application/xml'  -d '

<upload xmlns="http://www.financeactive.com/schemas/documents/v1"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">   

<document>
    <name>Test_doc</name>
      <type>Contrat</type>

<metas>

<meta>
<key>Couleur</key>
<value xsi:type="xs:string">Or</value>
</meta>

    <meta>
<key>Annee</key>
<value xsi:type="xs:long">2020</value>
</meta>

    <meta>
<key>VIP</key>
<value xsi:type="xs:boolean">true</value>
</meta>

</metas>

      <links>
<link>
<type>Deal</type>
<id>123456</id>
</link>
</links>

      <content>
       **Document en Base64**
      </content>

    </document>

</upload>

' 'https://debt.financeactive.net/rest/documents/upload'

 

Exemple 2 : Ajout d'un document à partir d'une URL

Ajoutons ce document :

Nom du document

Facture_doc

Type du document

Facture

Référence externe du produit

789012

URL

https://www.mycompany.com/url_to_my_doc

 

  1. Créez un type de document avec le code Facture.
  2. Saisissez cette commande :
curl -XPOST -v --header 'X-App-Token: Account's API-TOKEN ' --header 'content-type: application/xml'  -d '

<upload xmlns="http://www.financeactive.com/schemas/documents/v1"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">   

<document>
   <name>Facture_doc</name>
     <type>Facture</type>

      <links>
<link>
<type>Deal</type>
<id>789012</id>
</link>
</links>

     <url>https://www.macompagnie.com/url_vers_mon_doc</url>

    </document>

</upload>

' 'https://debt.financeactive.net/rest/documents/upload'

Remarque : Nous vous recommandons d'utiliser la dernière version de l'API.

Pour plus d'informations, voir également https://developer.financeactive.com/api.html.

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0