PINGDOM_CANARY_STRING

Additional resources

文書 API


文書を表示

文書 ID を指定することで、その文書に関するメタデータを取得することができます。このコールを行うには、署名された OAuth ヘッダーが必要です。XML 文書のレスポンスで成功した場合、このコールで HTTP ステータス200が返されます。

URL

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

レスポンス

<?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>

エラーが発生した場合、適切な HTTP レスポンスコード (200以外) が返され、レスポンス本文は XML となります。

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

文書を編集

文書を編集するには、対象のユーザーを Lucidchart エディターに送信する必要があります。文書のメタデータには、文書を編集するためにユーザーをリダイレクトできる「editUrl」が含まれています。サードパーティは、editUrl にクエリパラメーターを追加できます。このパラメーターにより、エディターにボタンが表示され、サードパーティのアプリケーションへのリンクが返されます。アプリとコールバックの両方を提供する必要があり、コールバックは URL エンコードする必要があります。

例えば、文書の editUrl が以下であると仮定します。

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

OAuth パラメーターをこの URL に追加することもできます (OAuth パラメーターの追加方法については、「Lucidchart の文書リストの表示」を参照してください)。

上記の例のアプリケーションへ戻るボタンを使用して Lucidchart エディターにユーザーを送信するには、ユーザーを次の以下のようにリダイレクトします。

 

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

新規文書

文書リストを経由せずに文書を直接作成するには、ユーザーを Lucidchart エディターに送信する必要があります。サードパーティは newDoc エンドポイントにユーザーを送信することができます。これにより、新しい文書で Lucidchart エディターが開き、サードパーティのアプリケーションへのリンクが返されます。URL エンコードされたコールバックを提供する必要があります。この URL には OAuth パラメーターも必ず追加します (OAuth パラメーターの追加方法については、「Lucidchart の文書リストの表示」を参照してください)。

ユーザーをリダイレクトする URL の形式は以下のとおりです。

 

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>

 

ユーザーがエディター内の新しい文書に転送され、「return to <app name for oauth key>」が表示されます。編集エンドポイントと同様に、ユーザーがボタンをクリックするとこのコールバックが呼び出され、クエリパラメーター documentId がコールバックURLに追加されます。そのため、コールバックのアプリには作成された文書の ID が付与されます。

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.

日本語
EnglishFrançaisDeutsch日本語PortuguêsEspañolNederlandsPусскийItaliano
プライバシー法的事項
© 2021 Lucid Software Inc.