Service Web chargement

Introduction

Ces Services web vous permettent de télécharger des fichiers directement dans Yuki au départ de votre propre application. Ces Services web fonctionnent par HTTP POST.

Les fichiers peuvent être postés un par un avec le type de contenu multipart/form-data et application/x-www-form-urlencoded.

Pour simplifier le processus de développement, vous trouverez dans le bas de cette page une série de liens vers des applications d'exemple avec lesquelles vous pourrez faire appel à cette méthode de Services web.

Vous trouverez les Services web, une application test, une description des champs et des procédures à l'adresse web indiquée ci-après.

Adresse web

https://api.yukiworks.nl/docs/Upload.aspx

Authentification

 Pour les comptables avec un portail  

Authentifier les comptables avec portail par la WebserviceAccessKey. Le WebServiceAccessKey peut être créé dans le portail du comptable.

Utilisateurs 

Les utilisateurs peuvent s'authentifier moyennant la WebserviceAccessKey ou le nom d'utilisateur et le mot de passe.

Statut de la réponse

Ces Services web offrent deux options pour relier le résultat de l'action POST.

• Par un message XML (méthode de rétroaction)

Le message XML se trouve dans la réponse de ce service web. Il contient le statut du téléchargement et des notifications de validation éventuelles.

• Par une redirection

Avec cette option, vous pouvez mentionner une adresse web qui détermine vers où il convient de rediriger le téléchargement si ce dernier a échoué ou réussi.

Paramètres

Domaine

Le nom du domaine où vous souhaitez livrer vos documents.

UserName

Le nom d'utilisateur avec lequel vous avez accès au domaine dans Yuki. Ce paramètre est obligatoire en l'absence d'authentification avec WebServiceAccessKey.

WebServiceAccessKey

Le WebServiceAccessKey peut être créé dans un domaine ou à travers le portail du comptable. Ce code d'accès peut permettre l'accès aux Services web au niveau de l'administration ou du domaine. Les instructions pour la création d'un code d'accès se trouvent sur cette page.

Administration

L'ID de l'administration vers laquelle vous souhaitez télécharger le document. Les instructions pour la récupération de l'ID d'administration se trouvent sur cette page.

Dossier

Le dossier dans lequel vous souhaitez enregistrer le document. La valeur standard de ce paramètre est « 7 ». Options possibles :

ID de dossier Description

FolderTab

L'onglet de dossier dans lequel vous souhaitez enregistrer le document. La valeur par défaut de ce paramètre est vide.

ProjectID

Il s'agit du HID du Projet auquel vous souhaitez lier le document. La mention de ce paramètre rend le paramètre « ProjectCode » superflu. L'option pour les projets doit correctement être activée dans le contrat.

ProjectCode

Le code du projet auquel vous souhaitez lier le document. Ce paramètre est uniquement utilisé si le paramètre « Project ID » n'est pas affiché. L'option pour les projets doit correctement être activée dans le contrat.

Fichier

Le document à livrer.

ResponseType

Ce paramètre détermine la manière dont ce service web répond à l'action POST. S'il s'agit d'un « XML », le résultat de l'action POST sera en format XML dans le navigateur. S'il s'agit de l'option de « Redirection », une redirection sera effectuée après l'action POST. La valeur par défaut de ce paramètre est XML.

RedirectUrlSuccess

Ce paramètre (string) est uniquement obligatoire en combinaison avec le ResponseType « Redirection » et détermine l'url vers laquelle il convient de rediriger si le téléchargement a réussi. Un paramètre supplémentaire est ajouté à cette url, « DocumentID= » avec pour valeur l'ID (GUID) du document stocké dans Yuki.

RedirectUrlFailed

Ce paramètre est uniquement obligatoire en combinaison avec le ResponseType « Redirection » (rediriger) et détermine l'url vers laquelle il convient de rediriger si le téléchargement a échoué. Un paramètre supplémentaire est ajouté à cette url, « DocumentID= » avec pour valeur l'ID (GUID) du document stocké dans Yuki.