PINGDOM_CANARY_STRING

Additional resources

API Dokument


Dokument anzeigen

Anhand einer Dokument-ID können die Metadaten zu dem jeweiligen Dokument abgerufen werden. Für diese Anfrage sind die Autorisierungskopfzeilen (Signed OAuth Headers) erforderlich. Wenn die Anfrage erfolgreich ist, wird der HTTP-Status 200 ausgegeben und die erfolgreiche Anfrage mit einem XML-Dokument beantwortet.

URL

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

Antwort

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

Bei aufgetretenen Fehlern wird ein entsprechender HTTP-Antwortcode (Nicht-200) und ein Antworttext im XML-Format ausgegeben.

<error>
   <status>401</status>
   <message>Access Denied</message>
</error>

Dokument bearbeiten

Zum Bearbeiten eines Dokuments muss der Anwender an den Lucidchart-Editor weitergeleitet werden. Die Metadaten des Dokuments enthalten eine „editUrl“, an die der Anwender zum Bearbeiten weitergeleitet werden kann. Drittanbieter können der editUrl einen Anfrage-Parameter hinzufügen, sodass im Editor eine Schaltfläche angezeigt wird, die mit ihrer Anwendung verlinkt ist. Hierfür ist die Angabe einer App sowie eines URL-kodierten Callbacks erforderlich.

Die editUrl für ein Dokument könnte z. B. folgendermaßen aussehen:

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

OAuth-Parameter können ebenfalls zu dieser URL hinzugefügt werden (Hinweise zum Hinzufügen von OAuth-Parametern finden Sie unter „Lucidchart-Dokumentenliste anzeigen“).

Die folgende URL leitet den Anwender zum Lucidchart-Editor weiter, wo eine Schaltfläche mit einem Link zur ursprünglichen Anwendung angezeigt wird:

 

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

Neues Dokument

Zur direkten Erstellung eines Dokuments (nicht über die Dokumentenliste) muss der Anwender an den Lucidchart-Editor weitergeleitet werden. Drittanbieter können Anwender zum Endpunkt „newDoc“ weiterleiten. Dadurch öffnet der Lucidchart-Editor ein neues Dokument und zeigt eine Schaltfläche an, die mit der Anwendung des Drittanbieters verlinkt ist. Hierfür ist die Angabe eines URL-kodierten Callbacks erforderlich. OAuth-Parameter sollten ebenfalls zu dieser URL hinzugefügt werden (Hinweise zum Hinzufügen von OAuth-Parametern finden Sie unter „Lucidchart-Dokumentenliste anzeigen“).

Die URL zur Weiterleitung des Anwenders hat folgende Form:

 

https://app.lucidchart.com/api/newDoc?callback=<your callback>&oauth_signature=<oauth signature>&oauth_version=1.0&oauth_nonce=<nonce>&oauth_signature_method=HMAC-SHA1&oauth_consumer_key=<consumer_key>&oauth_token=<token>&oauth_timestamp=<timestamp>

 

Im Editor wird dem Anwender ein neues Dokument mit dem Link „Zurück zu <app name for oauth key>“ angezeigt. Wie beim Endpunkt Bearbeiten wird der Callback abgerufen, wenn der Anwender auf die Schaltfläche klickt. Die Dokument-ID des Anfrage-Parameters wird zu der Callback-URL hinzugefügt, sodass die App, von der der Callback ausgeht, über die ID des erstellten Dokuments verfügt.

Notice: Moving forward you’ll find information on our current APIs on the new API documentation page, under the legacy section. It’s in the legacy section because we are actively improving our APIs and will release new versions in the future. You can continue using our current APIs and will receive substantial notice before any updates are made.

Deutsch
EnglishFrançaisDeutsch日本語PortuguêsEspañolNederlandsPусскийItaliano
DatenschutzRechtliches
© 2021 Lucid Software Inc.