📚 Join the Miro Community Book Challenge for a Chance to Win 🏆
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!
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`.
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.
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.
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).
We open sourced a library to template boards and integrate Miro into the company data flow.Miro.com is an awesome online whiteboard for visual collaboration. We fall in love with it right when using it for the very first time! Level 1: Scale up best practices with templatesOnce we started adopting Miro, we learned that certain usage patterns work better than others. Instead of reinventing the wheel with each new board, we wanted to roll out our best practices. What we needed were templates.Miro comes with a collection of pre-defined templates to get users started. Yet, we found that our specific use cases required more tailored templates. Although Miro doesn’t offer user-created templates as of today, Miro does have an API to programmatically create and query boards.So, we set out to explored the API route. We encountered some challenges as the API supports only a subset of what the Miro UI can but by-and-large it turned out pretty well! We can design boards in the Miro UI, convert the
NEXT and Miro come together to make the 'new normal' a better normal. Our goal with this partnership is to remove any friction from the user experience, so the end users don't feel like they are switching between multiple solutions when trying to get work done. Details: https://blog.collaborne.com/miro-next-creating-the-future-of-business-design-and-its-remote-35e8a371ecd4
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
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?
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).
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.
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.
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
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.
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)?
Already have an account? Login
Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.
Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.
Sorry, our virus scanner detected that this file isn't safe to download.
