Developer platform and APIs

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

  • 871 Topics
  • 2,750 Replies

871 Topics

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
4 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
4 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
4 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
3 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
4 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
1 year 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
4 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
1 year ago
Kiron Bondale
Kiron BondaleVolunteer Community Moderator
asked 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
3 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
4 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
4 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
4 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
4 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
4 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
4 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
2 years 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
2 years ago
ronny
ronnyContributor
posted in Developer platform and APIs

IDEA: Provide flexible colors for widgets

We would like to brand the look & feel of the canvas by using our own color schema (e.g. for background, stickies, shapes). Unfortunately, today, the API rejects any other color than the 12 predefined ones. PS: The example in the API Explorer doesn’t work because it uses invalid color #ff00ff (https://developers.miro.com/reference#create-board-widgets).

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

Positioning system

How does the positioning system in the RESTAPI work? What I understood so far is that x/y coordinates define the middle point of the widget and that the values seem to correspond to display pixels. In particular: which x/y coordinates and width/height is advised to use when placing widget (assumption: all team members have different devices)?

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

OpenAPI/swagger file to auto generate SDK

  Do you have a OpenAPI/swagger file for the Miro REST API? We want to auto generate a SDK for TypeScript/NodeJS SDK. In case you don’t have this, we saw this Typescript definition file on your Github: https://github.com/miroapp/app-examples/blob/master/miro.d.ts - Is the idea that we copy this for our usage (better: can we link it somehow, so we get updates when you adjust it)? Many thanks!

3
Thomas Vanier
1 year ago
Lena Shenkarenko
Lena ShenkarenkoExperienced Community Member
posted in Developer platform and APIs

Miro Hackathon – what would you build?

Internal hackathons are huge for Miro product culture. We organize them twice a year for two days and last month 20 teams were competing for the main prize for the 7th time in history. I just wanted to share some pictures from this internal event and give a sneak peek into the projects teams were working on.   For example, one of the teams called ‘Dotmocracy’ created a platform app for voting with a predefined amount of dots per user. Other projects include enhanced board history, plugin that allows to automate routine tasks on the board, and even custom Miro Instagram masks and stickers. I’m curious – if you were to participate in Miro Hackathon, what would you build? 

0
Lena Shenkarenko
4 years ago
Terms & Conditions