API Document


Voir le document

Un identifiant de document permet d'obtenir les métadonnées le concernant. Les en-têtes OAuth signés sont nécessaires pour émettre cette requête. Celle-ci renvoie un code d'état HTTP 200 si elle aboutit, avec une réponse sous forme de document XML.

URL

https://www.lucidchart.com/documents/describe/<ID_document>

Réponse

<?xml version="1.0" ?>
<documents>
   <document>
       <documentId>4df67392-0894-44ad-987e-6ab30a2e3afb</documentId>
       <title>Maquette n° 1</title>
       <editUrl>https://www.lucidchart.com/documents/edit/4df67392-0894-44ad-987e-6ab30a2e3afb</editUrl>
       <viewUrl>https://www.lucidchart.com/documents/view/4df67392-0894-44ad-987e-6ab30a2e3afb</viewUrl>
       <version>220</version>
       <pageCount>3</pageCount>
   </document>
</documents>

En cas d'erreur, un code de réponse HTTP approprié (autre que 200) est renvoyé, et le corps de la réponse est au format XML.

<error>
   <status>401</status>
   <message>Accès refusé</message>
</error>

Modifier le document

Pour modifier un document, l'utilisateur doit être dirigé vers l'éditeur Lucidchart. Les métadonnées du document contiennent une « URL de modification » (editUrl) vers laquelle l'utilisateur peut être redirigé afin de modifier son document. Un tiers peut ajouter à cette URL un paramètre de requête qui fera apparaître un bouton dans l'éditeur avec un lien vers son application. Une application et une fonction de rappel doivent être fournies, et cette dernière doit être codée dans l'URL.

Par exemple, supposons que l'URL editUrl d'un document soit :

https://www.lucidchart.com/documents/edit/4df67392-0894-44ad-987e-6ab30a2e3afb

Des paramètres OAuth peuvent également être ajoutés à cette URL (voir « Afficher la liste des documents Lucidchart » pour une description de l'ajout de paramètres OAuth).

Pour envoyer l'utilisateur vers l'éditeur Lucidchart avec un bouton de retour vers l'application de notre exemple, l'URL serait :

 

https://www.lucidchart.com/documents/edit/4df67392-0894-44ad-987e-6ab30a2e3afb?app=example&callback=http%3A%2F%2Fexample.com%0A

Nouveau document

Pour créer un document directement (et non via la liste des documents), l'utilisateur doit être envoyé vers l'éditeur Lucidchart. Un tiers peut envoyer un utilisateur au point de terminaison newDoc qui ouvrira l'éditeur Lucidchart avec un nouveau document et fera apparaître un bouton avec un lien vers leur application. Une fonction de rappel doit être fournie et codée dans l'URL. Des paramètres OAuth devraient également être ajoutés à cette URL (voir « Afficher la liste des documents Lucidchart » pour une description de l'ajout de paramètres OAuth).

L'URL de redirection de l'utilisateur se présente sous la forme suivante :

 

https://www.lucidchart.com/api/newDoc?callback=<votre rappel>&oauth_signature=<signature oauth>&oauth_version=1.0&oauth_nonce=<nonce>&oauth_signature_method=HMAC-SHA1&oauth_consumer_key=<clé_utilisateur>&oauth_token=<jeton>&oauth_timestamp=<horodatage>

 

L'utilisateur est alors dirigé vers un nouveau document dans l'éditeur et « retour à <nom de l'application de la clé oauth> » est affiché. Comme pour le point de terminaison de modification, la fonction de rappel est appelée lorsque l'utilisateur clique sur le bouton, et le paramètre de requête IDdocument est ajouté à l'URL de rappel pour que l'application vers laquelle l'utilisateur est renvoyé obtienne l'identifiant du document qui a été créé.