Documento de API


Ver documento

Con el ID de un documento, se pueden obtener los metadatos de ese documento. Se requieren los encabezados OAuth firmados para hacer esta llamada. La llamada devolverá un estado de 200 de HTTP si tiene éxito con una respuesta que es un documento XML.

URL

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

Respuesta

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

Si ocurre un error, se devolverá un código de respuesta HTTP apropiado (distinto a 200) y el cuerpo de respuesta será XML.

<error>
   <status>401</status>
   <message>Acceso denegado</message>
</error>

Editar documento

Para editar un documento, se debe enviar al usuario al editor de Lucidchart. Los metadatos del documento contienen un "editUrl" al cual se puede dirigir al usuario para editar ese documento. Un tercero puede agregar al editUrl un parámetro de petición que hará que aparezca un botón en el editor con un enlace de regreso a su aplicación. Es necesario proporcionar tanto la aplicación como la llamada de regreso y la llamada de regreso deberá estar codificada como URL.

Por ejemplo, supongamos que el editUrl para un documento es:

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

También se pueden agregar parámetros OAuth a esta URL (ver "Mostrar la lista de documentos de Lucidchart" para obtener una descripción de cómo agregar parámetros OAuth).

Para enviar al usuario al editor de Lucidchart con un botón de regreso a la aplicación del ejemplo, se dirigiría al usuario a:

 

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

Documento nuevo

Para crear un documento directamente (no a través de la lisa de documentos), se debe enviar al usuario al editor de Lucidchart. Un tercero puede enviar a un usuario al punto de conexión newDoc que abrirá el editor de Lucidchart con un nuevo documento y hará que aparezca un botón con un enlace de regreso a su aplicación. Es necesario proporcionar una llamada de regreso, la cual deberá estar codificada como URL. También se deben agregar parámetros OAuth a esta URL (ver "Mostrar la lista de documentos de Lucidchart" para obtener una descripción de cómo agregar parámetros OAuth).

La URL para redirigir al usuario tiene la forma:

 

https://www.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>

 

El usuario será llevado a un nuevo documento en el editor y se mostrará "regresar a <nombre de la aplicación para clave oauth>". Al igual que con editar punto de conexión, la llamada de regreso se hará cuando el usuario haga clic en el botón y se agregará el parámetro de petición documentId a la URL de llamada de regreso para que la aplicación en la llamada de regreso tenga el ID del documento que se creó.