Embedding

Shimoku provides the ability to embed board into existing Web applications. This powerful feature, referred to as Interactive Embedding (or Embedding, for short), allows you to provide personalized analytics to your customers, increasing the overall value of your product offering with minimal development effort.
To be able to embed you must create a board:
s.boards.create_board(
    name: str, order: Optional[int] = None,
    is_public: bool = False, is_disabled: bool = False
) -> Dict
​
You can assign any number of menu paths to your board:
s.boards.group_menu_paths(
    menu_path_names: Union[Optional[List[str]], str] = None, 
    menu_path_ids: Optional[List[str]] = None,
    uuid: Optional[str] = None, name: Optional[str] = None
)
​
And that's it! 
Now, to access to the link through the Front End, you must click in the chain of your board:
​
​
A pop up will show with both a Public URL link and an HTML embed code:
Further methods
# Creates a board and return it's dictionary representation
s.boards.create_board(
    name: str, order: Optional[int] = None,
    is_public: bool = False, is_disabled: bool = False
) -> Dict
​
# Gets a board, if the board does not exit it returns None
s.boards.get_board(
    uuid: Optional[str] = None, name: Optional[str] = None
) -> Optional[Dict]
​
# Deletes the specified board, if it exists
s.boards.delete_board(
    uuid: Optional[str] = None, name: Optional[str] = None
)
​
# Updates the specified board fields, if it exists
s.boards.update_board(
    uuid: Optional[str] = None, name: Optional[str] = None,
    new_name: Optional[str] = None, order: Optional[int] = None,
    is_public: Optional[bool] = None, is_disabled: Optional[bool] = None
)
​
# Adds a menu path to a specified board, this creates a link object
s.boards.add_menu_path_in_board(
    menu_path_name: Optional[str] = None, menu_path_id: Optional[str] = None,
    uuid: Optional[str] = None, name: Optional[str] = None
)
​
# Gets all the menu path ids for a specified board
s.boards.get_board_menu_path_ids(
    uuid: Optional[str] = None, name: Optional[str] = None
) -> List[str]:
​
# Deletes the link between a given an menu path and a given a board
s.boards.remove_menu_path_from_board(
    menu_path_name: Optional[str] = None, menu_path_id: Optional[str] = None,
    uuid: Optional[str] = None, name: Optional[str] = None
)
​
# Gets all the workspace boards
s.workspaces.get_workspace_boards(
    self, uuid: Optional[str] = None, name: Optional[str] = None
)
​
# Delete all workspace boards
s.workspaces.delete_all_workspace_boards(
   self, uuid: Optional[str] = None, name: Optional[str] = None
)
Last modified 1mo ago