Document API


Document weergeven

Met een document-ID kunnen de metagegevens over dat document worden verkregen. Voor deze aanroep zijn de ondertekende OAuth-headers vereist. Indien geslaagd, retourneert de aanroep een HTTP-status 200 met een XML-document als respons.

URL

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

Respons

<?xml version="1.0" ?>
<documents>
   <document>
       <documentId>4df67392-0894-44ad-987e-6ab30a2e3afb</documentId>
       <title>Mock-up #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>

Als er een fout optreedt, wordt een bijbehorende HTTP-repsonscode geretourneerd (niet 200) en is de body van de respons XML.

<error>
   <status>401</status>
   <message>Toegang geweigerd</message>
</error>

Document bewerken

Om een document te kunnen bewerken, moet de gebruiker naar de Lucidchart-editor worden gestuurd. De metagegevens van het document bevatten een 'editUrl' waar de gebruiker naartoe geleid kan worden om het document te bewerken. Een derde kan aan de editUrl een queryparameter toevoegen waardoor een knop in de editor verschijnt met een link terug naar de app van die derde. Zowel een app als een callback moeten worden opgegeven en de callback moet URL-gecodeerd zijn.

Stel dat dit de editUrl voor een document is:

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

Aan deze URL kunnen ook OAuth-parameters worden toegevoegd (zie 'De Lucidchart-documentenlijst weergeven' voor instructies voor het toevoegen van OAuth-parameters).

Om de gebruiker naar de Lucidchart-editor te sturen met een retourknop naar de voorbeeldapplicatie, wordt de gebruiker omgeleid naar:

 

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

Nieuw document

Om rechtstreeks een document aan te maken (niet via de documentenlijst), moet de gebruiker naar de Lucidchart-editor worden gestuurd. Een derde kan een gebruiker naar het newDoc-eindpunt sturen, dat de Lucidchart-editor met een nieuw document opent en een knop met een link terug naar de app van die derde doet verschijnen. Er moet een callback worden opgegeven en de callback moet URL-gecodeerd zijn. Aan deze URL moeten ook OAuth-parameters worden toegevoegd (zie 'De Lucidchart-documentenlijst weergeven' voor instructies voor het toevoegen van OAuth-parameters).

De URL waarnaar de gebruiker wordt omgeleid, heeft de vorm:

 

https://www.lucidchart.com/api/newDoc?callback=<uw callback>&oauth_signature=<oauth-handtekening>&oauth_version=1.0&oauth_nonce=<nonce>&oauth_signature_method=HMAC-SHA1&oauth_consumer_key=<consumer_key>&oauth_token=<token>&oauth_timestamp=<tijdstempel>

 

De gebruiker wordt naar een nieuw document in de editor gebracht en 'terug naar <app-naam voor oauth-sleutel>' wordt weergegeven. Net als bij het eindpunt bewerken, wordt de callback aangeroepen wanneer de gebruiker op de knop klikt en wordt de queryparameter documentId toegevoegd aan de callback-URL, zodat de app bij de callback de ID heeft van het document dat is gemaakt.