Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at developers.miro.com

  • 704 Topics
  • 2,328 Replies

704 Topics

T
Tomas Mundt-PetersenBeginner
asked in Developer platform and APIs

Change size of BottomPanel

Hi How do I change the size of the BottomPanel when opening it from javascript?   miro.initialize({     extensionPoints: {       bottomBar: {         title: 'Timer',         svgIcon: icon24,         onClick: () => {           miro.board.ui.openBottomPanel('index.html')         }       },     }   })

5
T
3 years ago
A
alloplasticBeginner
asked in Developer platform and APIs

OAuth for Web Plugin

Hi, In sharing a web plugin with a team, do we need to “wrap” Miro REST calls on our application server (e.g. within a Node.js server), sending the authorization in the header for each service call? Or can our plugin code remain as it is?  Currently, our test plugin makes use of code like this, using the Miro API that gets loaded automatically in the context of the plugin:      miro.board.widgets.create() Without OAuth, this works for the user who created and installed the plugin.  However, though other team members can invoke the plugin, they don’t have the authorization for this command to work. Basically, I’m wondering whether, for “web plugins” specifically, the OAuth flow is meant for a one-time installation by each team member, or whether the authentication has to be managed for each user every time they are using the plugin and/or whenever a specific Miro API is called. Thanks, Sheldon 

1
Boris Borodyansky
Mironeer
3 years ago
S
Simon JonesBeginner
posted in Developer platform and APIs

Missing endpoints for API

Some important API endpoints seem to be missing from the Miro API, especially related to the Teams object. I would like to see the ability to list all Teams for a company or create a new Team through an API call. Also there appears to be no endpoints for Projects, which is disappointing. Ideally I’d like the ability to list all teams for a Project and add/delete users from a Project. Are either of these on the roadmap for Miro? 

3
J
3 years ago
A
alloplasticBeginner
asked in Developer platform and APIs

Can a custom web plugin be installed for individual users and boards?

Hi. I have created s simple “Web-plugin,” which I have successfully installed for the Dev Team.  Every developer can see the new plugin button in the toolbar when they go to a Dev Team board. What I would like to do is let individual users in my company (or individual boards) use the plugin.  However, since we have about 1,000 employees around the world, I don’t want to install the plugin for all of them. Is there a way to accomplish this?  On a single Miro board, there appears to be a way to add a plugin just to that board, but the UI only shows plugins in the Marketplace, not our custom plugin.  When I use the “Install App and get OAuth token” button on the developer screen, I get a choice of teams, but I only see our top-level company team, not the individual project teams within the company. Am I overlooking a way to share the plugin at a more individual level? Thanks. Sheldon  

3
F
3 years ago
Kirill Hazukov
Kirill HazukovNew Here
asked in Developer platform and APIs

Add icon to widgetContextMenu

Hi everyone! How i can add an application icon to the widgetContextMenu? By looking at the documentation, i tried the following code: miro.onReady(() => {  miro.initialize({    extensionPoints: {      widgetContextMenu: {        title: 'Hi',        svgIcon: "<circle cx=\"12\" cy=\"12\" r=\"9\"></circle>",      }    }  })}) but in console i get the following error However, I can do it in bottomBar if I replace “widgetContextMenu” with “BottomBar”.

3
Kirill Hazukov
3 years ago
acyment
acymentBeginner
posted in Developer platform and APIs

Is it possible to block certain actions on images? (e.g. rotation)

Hi  there! I’m developing an uber-simplified Sim-City-like simulation to use on a training setting. I’d like to know if there is a way to block actions like scaling or rotation on images.   Thanks! Alan

4
mlanders
3 years ago
Falk Kühnel
Falk KühnelActive Contributor
asked in Developer platform and APIs

Positioning an element with a click

I want to position items on the canvas with a user click. At the moment I used the „CANVAS_CLICKED“ event. Is there a different way to do that? 

1
Boris Borodyansky
Mironeer
2 years ago
mlanders
mlandersExperienced Community Member
asked in Developer platform and APIs

Error in sticky notes

I have noticed something strange: I created a Sticky Note and wanted to wrap the words into two lines. As I clicked enter it shows me this: I have seen this only one time before but I cannot remember how I could reproduce it. Any solution? Michael

3
mlanders
3 years ago
Falk Kühnel
Falk KühnelActive Contributor
asked in Developer platform and APIs

Can we add custom Items in Plugins like cards or specifically rendered items?

Hi!   I would like to be able to add items, that have a certain functionality and would need a special rendering, like having dice represented on the board or playingcards, that can be flipped, or an avatar with a hands up indicator. Is there a way to do that? The normal API options do not allow for something like this.   Thanks Falk

4
Kiron Bondale
3 years ago
Falk Kühnel
Falk KühnelActive Contributor
posted in Developer platform and APIs

CANVAS_CLICKED event

Hi!   I was using the CANVAS_Clicked event to place objects with the x and y attribute of the event. Now these have disappeared and i have not found out how to use the new event info how to place an item right at the click point on the canvas. Can anyone help?   Thanks Falk

4
Falk Kühnel
3 years ago
R
Roman WaltherBeginner
asked in Developer platform and APIs

Help with Web Plugin

Hello,  ich have a problem with my first Miro Plugin. Attached a video that shows the issue: https://storyxpress.co/video/k8shzojjkpud07w0c Thanks for your help BR Roman

6
R
3 years ago
M
MelanieNew Here
asked in Developer platform and APIs

Problem with content blocked error/ warning when trying to run a web plugins example

Dear Miro dev Community,   I’m trying to run the ‘Stickers and Shapes’ web plugin example code in my Sandbox running a ngrok server locally. Although the SDK loads and the plugin in being initialised, I’m getting the following error/ warning: [blocked] The page at about:blank was not allowed to display insecure content from http://11d1b29e.ngrok.io/<file path> (see screen grab below). I’m using Safari on a Mac.   I’d really appreciate if you could provide some advice.    Many thanks!  

5
P
2 years ago
M
MarkNew Here
asked in Developer platform and APIs

Simple plugin no longer working. XML Parsing Error: prefix not bound to a namespace?

Hi, I had a simple plugin up and running that executed a function when I clicked a new icon in the bottomBar. I used some of the example code to get up it set up and everything worked ok. Now the icon no longer appears in the bar. The browser tools show that there is an error message (before the plugin is loaded though) that says: XML Parsing Error: prefix not bound to a namespace. I am not sure if this error message is new or not. Has something changed that means the the button-display code needs to change? The relevant plugin code is: miro.onReady(() => { miro.initialize({ extensionPoints: { bottomBar: { title: 'Post-it Counter', svgIcon: '<circle cx="12" cy="12" r="9" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-width="2"/>', onClick: async () => {...} updateCount(); } } })})

2
M
3 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

IDEA: Add hidden markers to widget

We create widgets via the Miro API and query them afterwards back. We need to know which widgets are what (e.g. to find stickers placed within a specific widget). So far, we rely on the text to match the enclosing widget. Yet, this leads to issues if users change the text in the Miro UI and it’s cumbersome if boards are localized (i.e. lots of text variants to match). (Aa an alternative, we considered storing the Miro widget ID but that’s tricky as it requires us to hold this state.) We would like to send a hidden marker to the API during widget creation, which is then returned when querying for widgets. As a parallel, consider the ID field in HTML elements: The developer sets it, website users don’t see it and can’t change it, yet developers can query the elements afterwards with this ID via `getElementById`.

4
Anthony Roux
Mironeer
10 months ago
ronny
ronnyContributor
posted in Developer platform and APIs

IDEA: Provide webhook if user deauthorizes app

We show in our app a button that allows users to link their Miro profile to our app. Once authorized (via OAuth flow) we deactivate the button, so users understand that Miro is linked. Yet, if the user deauthorizes our app within Miro, we don’t know about it - i.e. our app shows the wrong information. It would be great if you could add a webhook to inform when the user deauthorizes our app. See for inspiration Zoom: https://marketplace.zoom.us/docs/guides/auth/deauthorization  

1
Boris Borodyansky
Mironeer
3 years ago
Rico Trevisan
Rico TrevisanContributor
asked in Developer platform and APIs

Download board backup via API?

Hi, is it possible to download the board backup via the API? I've looked through the reference and I didn't see anything. Did I overlook it? Is it possible?   Where could I make such feature request?

10
Alyona
Mironeer
10 months ago
Kiron Bondale
Kiron BondaleVolunteer Community Moderator
posted in Developer platform and APIs

Simple random number generator?

Would there be a quick and dirty way to create a random number widget/addin which could be used for things like simulating a coin flip or rolling a dice?  Right now, I’m using an external URL to Google Dice but would prefer something which didn’t require learners to jump out of their class boards. Thanks! Kiron

42
V
2 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

Provide cross-team tokens

Right now, the Miro access tokens are bound to a specific user and a specific team. This requires users to authorize our app multiple times with Miro (for each team). Our users found this pretty counter-intuitive. Their expectations are set by Zoom/Slack/Github which asks users during their default OAuth flow only once to connect the account. It would therefore be easier to if Miro OAuth access tokens could work across teams (and the API requires the team_id as a parameter when e.g. creating a board).  

2
ronny
3 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

Allow creating widgets with transparent borders

Today, the api doesn’t allow to set the borderColor to “transparent”. Not setting any value, Miro defaults the border to black. We figured out that setting the borderOpacity to 0 is a possible workaround. Yet, this isn’t ideal because getWidgets doesn’t do this if users create transparent borders in the Miro UI (i.e. input and output API aren’t consistent). It would be great if you would allow API developers to set the border color to transparent.

2
ronny
3 years ago
ronny
ronnyContributor
asked in Developer platform and APIs

How to change the logo on the OAuth authorize page?

When users are asked to authorize our app to access Miro (OAuth), Miro shows a generic logo on the page. How can we change this to our company logo?  

1
Boris Borodyansky
Mironeer
3 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

Align supported colors in API with UI

The API allows to use the following colors for widgets (every other color is rejected): #F5F6F8, #FFF9B1, #F5D128, #D0E17A, #D5F692, #A6CCF5, #67C6C0, #23BFE7, #FF9D48, #EA94BB, #F16C7F, #B384BB Yet, the Miro UI itself supports a different set of colors: #fef445, #fac710, #e6e6e6, #f24726, … This confuses users of API generated widgets because they can’t reproduce the same ones in the UI.  

2
ronny
3 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

Consistent endpoint to trigger OAuth flow

Regarding the docu (https://developers.miro.com/reference#authorization-and-authentication), the endpoint to trigger the oauth flow is “https://miro.com/oauth/authorize” whereas the code exchange endpoint is “https://api.miro.com/v1/oauth/token”. The API calls itself are as well “https://api.miro.com/v1/boards/id”. This is unexpected and not overly nice when writing integration code. It would be better if you the /authorize endpoint would be consistent => https://api.miro.com/v1/oauth/authorize

1
Boris Borodyansky
Mironeer
3 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

Return access token in OAuth flow if Miro was installed earlier

The Miro OAuth flows shows a page on which the user can select the team to which Miro should be installed. Afterwards, the code (and subsequently the access_token) is provided. Yet, the flow can be only executed once because the “Installed” button isn’t clickable. This means, in case the application looses the Miro access-token (which I understand from the docu should be cached forever), the user is required to deinstalled the application from Miro and then trigger again the OAuth flow.  

1
Boris Borodyansky
Mironeer
3 years ago
ronny
ronnyContributor
asked in Developer platform and APIs

Upload image into board

I managed to upload the logo of the board via the picture endpoint (https://developers.miro.com/reference#create-or-update-picture). How can I upload an image to the board itself? Use case: We want to upload our logo via the API when creating new boards.

6
Anthony Roux
Mironeer
1 year ago
ronny
ronnyContributor
posted in Developer platform and APIs

Label widgets via API

We try to add labels to widgets via the API (as you can do in Miro UI) but we fail to find out to do this via the REST API. Could you point to docu how to do this? PS: Our use case is to set the labels during createWidget request.  

17
Anthony Roux
Mironeer
1 year ago
Terms & Conditions