API Graph (bêta)

API Graph

Un tiers peut demander des informations sur tous les blocs, lignes, connexions et champs de texte. Aucune information de mise en forme n'est renvoyée. Cette API est en phase bêta.

Toute forme personnalisée créée ou renommée après le 8 juillet 2013 aura également un attribut <customName>

URL

https://app.lucidchart.com/api/graph/<identifiant du document>

Paramètres OAuth

Obligatoire

Réponse

document
  documentId
  title
  version
  blocks
    id
    class
    customName (si disponible)
    textAreas
        textArea
            key
            value
        textArea
            key
            value
        ...*
    text (si disponible)
    link (si disponible)
    field (si disponible)
  lines
    id
    endpoint1
      style
      text (si disponible)
      line (si connecté à un élément line)
      block (si connecté à un élément block)
    endpoint2
      * voir endpoint1

exemple

https://app.lucidchart.com/api/graph/4e8cc0f9-69f8-4d42-9993-0d5633ee25f2

<document>
  <documentId>4e8cc0f9-69f8-4d42-9993-0d5633ee25f2</documentId>
  <title>asd</title>
  <version>70</version>
   <blocks>
     <block>
     <id>Sh6DwyXm4ZYP</id>
     <class>ERDEntityBlock</class>
     <field>Field</field>
     <field>Field</field>
   </block>
     <block>
     <id>Qn6DHVIX_Z_J</id>
     <class>ProcessBlock</class>
     <text>Process</text>
   </block>
     <block>
     <id>gx6D89zN5VyN</id>
     <class>OffPageLinkBlock</class>
     <link>ext:https://app.lucidchart.com</link>
     <text>Off-Page Link</text>
   </block>
  </blocks>
    <lines>
     <line>
     <id>Ei6DlbvpCxJz</id>
       <endpoint1>
       <style>None</style>
     </endpoint1>
      <endpoint2>
      <style>Arrow</style>
     </endpoint2>
   </line>
    <line>
     <id>Gi6DFkSl4VEu</id>
      <endpoint1>
      <style>None</style>
      <block>Sh6DwyXm4ZYP</block>
     </endpoint1>
      <endpoint2>
      <style>Arrow</style>
      <line>Ei6DlbvpCxJz</line>
     </endpoint2>
     <text>right here</text>
   </line>
  </lines>
</document>

Documentation

Débogage côté client

Pour visualiser ce que l'API Graph renvoie suite à un appel côté serveur (sans avoir à en lancer un), vous pouvez ouvrir un document dans Chrome, accéder à la console JavaScript (Ctrl+Maj+j) et saisir :

Une chaîne XML contenant les données graphiques des blocs et les lignes sélectionnés est générée ou, si aucune n'est sélectionnée, l'état de l'ensemble du document est affiché.

Clés des zones de texte de la bibliothèque de formes