Skip to main content

Hi team,

I am building a application where it takes lucidchart ID as input and in the backend I will fetch the lucidchart in JSON format using document contents endpoint and does some validations like every shape should have some text, whole lucidchart should be connected. If any of the validations are not met, I want to show those on the UI. I am thinking it would be great if we can embed lucidchart and highlight the nodes where the validations are not met. Is there anyway I can do this ?

If not, do you suggest any other best alternative ?

Hello Sanath,

Currently, this would not be possible via the Rest API as you would not have a way to communicate back to the document where the errors are. Instead, you would want to approach this scenario via the Extension API, likely through its `document contents` functionality: https://developer.lucid.co/docs/editor-extension-document-content. With that, users could validate real time while in the Lucid editor like you describe.

One important note is that some extension functionality do not run when viewing a document as an embed. But, as long as someone opens the document in lucid.app the extension would run and the validations would be ran.

 


Hi Michael,

Thanks for the response. So if we are proceeding with extension API then we no longer require web application and user can directly see those validations in their lucid.app document if they download the package in there lucid.app ?

Is my understanding right. If so can you also please guide on how can I take the inital steps.

 


Correct, with some clarification.

Any collaborator on the application which contains the extension will see the validation when in Lucid. Additionally, the application could be privately published and pushed to all users if you wanted everyone on the account to have access.

Here are some resources that elaborate:

I am happy to further clarify any details.


Reply