API de documento


Visualizar documento

Com o ID do documento em mãos, os metadados sobre esse documento podem ser obtidos. Os cabeçalhos OAuth assinados são necessários para fazer esta chamada. A chamada retornará um status HTTP 200 se houver êxito, contendo uma resposta de documento XML.

URL

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

Resposta

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

Se ocorrer um erro, um código de resposta HTTP apropriado será retornado (não-200) e o corpo da resposta será XML.

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

Editar documento

Para editar um documento, o usuário deve ser enviado para o editor do Lucidchart. Os metadados do documento contêm um "editURL" (que seria um URL de edição, o qual inclui "edit" no caminho) para o qual o usuário pode ser direcionado para editar seu documento. Um terceiro pode adicionar um parâmetro de consulta ao editURL fazendo com que apareça um botão no editor contendo um link para acessar seu aplicativo. É necessário fornecer um aplicativo e retorno de chamada, e o retorno de chamada deve ser codificado em URL.

Por exemplo, suponha que o editURL de um documento seja:

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

Parâmetros OAuth também podem ser adicionados a este URL (veja "Exibir a lista de documentos do Lucidchart" para saber como adicionar parâmetros OAuth).

Para enviar o usuário ao editor do Lucidchart com um botão de retorno para o aplicativo de exemplo, o usuário seria redirecionado para:

 

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

Novo documento

Para criar um documento diretamente (não através da lista de documentos), o usuário deve ser enviado ao editor do Lucidchart. Um terceiro pode enviar o usuário ao endpoint do newDoc, que abrirá o editor do Lucidchart com um novo documento e fará com que apareça um botão contendo um link para acessar o aplicativo. É necessário fornecer um retorno de chamada, devendo ser codificado em URL. Parâmetros OAuth também devem ser adicionados a este URL (veja "Exibir a lista de documentos do Lucidchart" para saber como adicionar parâmetros OAuth).

O URL para o qual o usuário será redirecionado tem o seguinte formato:

 

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>

 

O usuário será levado para um novo documento no editor e "retornar para <nome do aplicativo para a chave oauth>" será exibido. Assim como no endpoint de edição, o retorno de chamada será chamado quando o usuário clicar no botão e o parâmetro de consulta documentId adicionado ao URL do retorno de chamada, para que o aplicativo no retorno de chamada tenha o ID do documento que foi criado.