Skip to main content

🖼️ Web-widget (iframe) - embed

Deprecation Notice

Heads‑up! This API is being sunset.

What this means for you​

  • Existing integrations keep working but no new features will be added.
  • Bug‑fixes and security patches are best‑effort only during the deprecation window.
  • After the sunset date, requests will return HTTP 410 (Gone).
  1. Migrate to our new API: see the Trident API for a step‑by‑step walkthrough.
  2. Update client libraries and SDKs to their latest major version.
  3. Reach out on [email protected] if you need help or an extension.

Thank you for building with us!
Your feedback has shaped the next generation of our platform, and we’re here to make the transition as smooth as possible.

Dockflow Web Widget (iframe)​

The Dockflow Web Widget allows you to embed our web application seamlessly into your website. This documentation provides guidance on how to integrate and customize the widget.

Integration​

To integrate the Dockflow Web Widget into your website, follow these steps:

  1. Obtain your Web Widget API Key from Settings > Organisation > Web Widget API Key in the Dockflow application.
  2. Embed the following iframe code into your HTML page:
<iframe src="https://widget.dockflow.com?key=YOUR_API_KEY_HERE" width="600" height="400" frameborder="0"></iframe>

Replace YOUR_API_KEY_HERE with your actual API key obtained in step 1.

Arguments​

The following arguments can be appended to the widget URL:

  • key: (mandatory) Your Web Widget API Key.
  • search: (optional) A reference to search for within the Dockflow application.
  • hash_search: (optional) A SHA256-hashed reference to search for. This is useful for preventing users from manually searching other files.

Example Usage​

  1. Basic usage with only the mandatory key argument:
https://widget.dockflow.com?key=YOUR_API_KEY_HERE
  1. Usage with additional search reference:
https://widget.dockflow.com?key=YOUR_API_KEY_HERE&search=reference
  1. Usage with SHA256-hashed search reference:
https://widget.dockflow.com?key=YOUR_API_KEY_HERE&hash_search=hashed_reference

Customization​

You can customize the appearance and behavior of the widget by modifying the iframe attributes such as width, height, etc. Additionally, you can apply CSS styles to the widget container on your website to further customize its appearance.