Developer platform and APIs

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

  • 858 Topics
  • 2,735 Replies

858 Topics

William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs

Webinar Recording: Getting Started with the Miro Developer Platform

Hey, everyone!  👋Last month we hosted a developer webinar, where @Addison Schultz and I walked through how to get started with the Miro Developer Platform. We’ve now made this webinar available for everyone to watch and would like to invite you to go have a look here:In this webinar, you'll learn how to quickly start calling our SDK and API endpoints and developing an app or integration of your own on Miro. There are plenty of best practices and tips that can be helpful when you are developing with the Miro Developer Platform.Hope you find this content useful and enjoy the webinar!Will & AddisonP.S. If there are any specific topics you'd like us to cover in future webinars please let us know on this thread, we'd love to hear your opinion 😀

0
William Bishop
Mironeer
1 year ago
S
SengokuSayanoBeginner
posted in Developer platform and APIs

Line styles do not display properly

I am creating an application using WEBSDK ver1.0.When you open the application you created, a sidebar appears. When you select a line from the sidebar and drag it to the board, a dashed line should appear, but a normal line appears.When I reload the application, it changes to dashed lines.The WEBSDK ver1.0guide says to set it to "1" to output dashed lines, is there something else I need to do?

2
S
1 year ago
K
Kapildev NeupaneBeginner
posted in Developer platform and APIs

[API] How to create a board with sharing access set to owner_and_coowners?

Hi,As the question already said, I want to create a board with sharingAccess set to owner_and_coowners. However, as the following request’s response shows, it failed.RequestPOST https://api.miro.com/v2/boards{ "name": "Name of board", "policy": { "permissionsPolicy": { "collaborationToolsStartAccess": "all_editors", "copyAccess": "board_owner", "sharingAccess": "owner_and_coowners" }, "sharingPolicy": { "access": "edit", "inviteToAccountAndBoardLinkAccess": "no_access", "organizationAccess": "private", "teamAccess": "edit" } }, "description": "Some Description", "teamId": "{{teamId}}"}Response{ "type": "error", "code": "4.0105", "message": "Some features are missing to set the board policies provided. Please check your account settings.", "status": 403}The response above says that some features are missing to set board pol

7
G
1 year ago
S
SengokuSayanoBeginner
posted in Developer platform and APIs

Enumerated line types are displayed as usual, even if they are dashed lines.

I am creating an application using WEBSDK ver1.0.I was able to display dashed lines until now, but suddenly they are displayed as normal lines.When I reload the application, it changes to dashed lines, but I wonder if there has been a specification change on Miro's side.The guide says to set it to "1" to output dashed lines, but is there something else I should do?

1
Addison Schultz
Mironeer
1 year ago
A
Arsi KerhaNew Here
posted in Developer platform and APIs

How to monetize Miro apps?

Hi everybody,I’m new to the ecosystem, and I’m looking around if it’s a good place for me to unleash creativity and start creating apps.I would like, however, to have the possibility to monetize them, and I haven’t found anything about it in the documentation.Is there any possibility to earn money from Miro Apps?If so, how?Best regards,Arsi

1
Addison Schultz
Mironeer
1 year ago
A
AlexeiBeginner
posted in Developer platform and APIs

REST API update geometry errors

Hi, I’m having problems changing the geometry of a card.e.g. (from python)payload = { 'geometry':{'width':260, 'height':130}}url = f"https://api.miro.com/v2/boards/uXjVPdveOFo=/cards/3458764531765310379"response = requests.patch(url, json=payload, headers=headers).json()results in {'type': 'error', 'code': '3.0215', 'context': {'boardId': 'uXjVPdveOFo=', 'itemId': '3458764531765310379', 'validationErrors': [{'code': '3.0211', 'message': 'Value for width should be greater than or equal to 256.0, found: 147.39173256538714'}]}, 'message': 'Unable to complete operation because of the validation errors.', 'status': 400} which doesn’t make sense as the width I’m setting is > 256. It seems if the card has been manually resized at some point, the API call will either get ignored (response returns the size set, but item on canvas does not change) or it returns a nonsensical error.Is this a bug in the API?

5
A
1 year ago
Matthias.Cullmann
Matthias.CullmannContributor
posted in Developer platform and APIs

PATCH //miro.com/api/v1/scim/Users userName not unique

Trying to update an existing user as of https://developers.miro.com/docs/users#update-user-attribute-by-idIf the taget userName belongs to a deleted account, I get …{  "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:Error" ],  "status" : "400",  "scimType" : "invalidValue",  "detail" : "User name '*******@baloise.com' is invalid: 'not unique'"} You can reproduce this with the user ID 3074457348934407798. The UPN can not be changed to the baloise.com email domain. Expected behaviour: a deleted account does not count as duplicate and it is possible to reuse UPN’s of deleted accounts.

5
Matthias.Cullmann
1 year ago
Abhijeet Narvekar
Abhijeet NarvekarNew Here
posted in Developer platform and APIs

Web Plugin: Select Text In Widget

Hi,I am developing a web plugin for Miro. I want to select text inside a TextWidget. (As shown below)Couldn’t find any documentation if it possible to highlight text inside a widgetAny suggestions? Best,Abhijeet​​​​​​​

12
Marco Spinello
Mironeer
1 year ago
A
aurechBeginner
posted in Developer platform and APIs

SDK v2 Full Modal Styling Control

  Hey, I think I posted this in the wrong / suboptimal category, sorry: Hey there     I would like to use a Modal within my App’s UI, but am faced with a rather suboptimally looking result when it comes to the backdrop:   Use case 1: Plugin’s settingsWith SDK v1, the entirety of the modal in which the App is rendered could be styled, but with SDK v2, it seems that you guys enforce a (admittably healthy) default padding outside of a Plugin dev’s control (on the “rtb-modal-container__content” I think?).   Use case 2: Import progress  Any chance we can get back (or somehow have) (full/partial) control over the modal’s styling?  Or will I have to scratch the idea and just use the whole iFrame, without any backdrop?  

1
Addison Schultz
Mironeer
1 year ago
L
Lakshman Kumar KalasamudramBeginner
posted in Developer platform and APIs

Removal of Miro lable from embedded Miro board

I am embedding the Miro board in my application. Is there a way for me to remove or hide the Miro label on top left corner when I embed the board in my app?It will be useful if there is any way please let me know.

2
mlanders
1 year ago
F
Filipp FedchinBeginner
posted in Developer platform and APIs

Miro LTI integration for Brightspace LMS

Right now there is only Canvas LTI integration with Miro. Taking into account that LTI is a standard, it is logical to develop LTI integration open for all other LMS (e.g. Brightspace LMS).

0
F
1 year ago
F
Filipp FedchinBeginner
posted in Developer platform and APIs

Miro Brightspace LTI integration

Are there any plans for providing Miro LTI integration for other LMS apart from Canvas, and specifically for Brightspace?

1
Addison Schultz
Mironeer
1 year ago
L
Lonni PRONNIERBeginner
posted in Developer platform and APIs

MIRO API Rest : Error 404 - Organization not found

Hello, When I used the page https://developers.miro.com/reference/get-logs to test my app, I have this error message : {  "status": 404,  "code": "notFound",  "message": "Organization not found",  "type": "error"} My request is :  $headers=@{}$headers.Add("Accept", "application/json")$headers.Add("Authorization", "Bearer I mask it it is better :) ")$response = Invoke-RestMethod -Uri 'https://api.miro.com/v1/audit/logs?createdAfter=2022-08-01T09%3A45%3A00.000%2B02%3A00&createdBefore=2022-08-01T10%3A45%3A00.000%2B02%3A00&limit=10&offset=0' -Method GET -Headers $headers My app has the auditlogs:read role as requested and I am admin.  Do you have an idea why it is not working ?  Thanks in advance Regards

3
L
1 year ago
A
aurechBeginner
posted in Developer platform and APIs

Retriggering app_card:connect

Hey there I’ve been updating our app that imports data from an external Issue management system to SDK v2.  After I’ve done some tinkering with the new synchronization options offered with v2, I’m left with following question: How can we, respectively when does Miro (offer) re-sync for the created App Cards?  In the SDK Reference, I could only find a reference about the event firing when you click the “Connect” button on the card, which I could only do once, after creating the item. Even after reloading the board, the Item is apparently still connected.But how can I thereafter sync any updates I add on the external data source? How can I, or when does Miro ever (propose a) re-sync?

4
A
1 year ago
S
Saul QuispeNew Here
posted in Developer platform and APIs

Miro Web SDK

Hello everyone, I'm adding assets to miro as a personal project but it disconnects every 4minutes, could someone help me or tell me what I'm doing wrong, I followed the example that I look at it gives us in its documentation : https://developers.miro.com/docs/web-sdk-how-tos 

1
Addison Schultz
Mironeer
1 year ago
L
Lakshman Kumar KalasamudramBeginner
posted in Developer platform and APIs

How can pass user login credentials to web SDK authentication without actually passing in the pop up

I am building an application which will actually connect to Miro web SDK, give username and password, sign in, pick a board to view, embed that board in my app using Board Picker. My app will allow multiple users to access it and if a user logs in to the Miro through sdk once next time onwards the login is not needed. How can I achieve below requirement?My requirement :(Consider my app has the clientId, clientSecret, user Miro email id, User password <if needed>)User “raj” logs into my app using the email id with which he has his miro account. After login raj clicks on a button BoardPicker. It should show the boards related to raj directly without him explicitly doing the login. My app should do that login and show the boards directly to him to select and embed.  Please tell me how I can achieve this. 

2
Anthony Roux
Mironeer
1 year ago
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs

Announcing our Community Apps Contest!

Join our Community App Contest and build on the Miro Developer Platform! Enter your app for a chance to win some exclusive Miro Developer SWAG and the opportunity to be promoted across our Developer Community. Contest DetailsBuild an app on the Miro Developer Platform that covers one of our community-inspired use cases!PrizeThe winning app will receive:Promotion via our Miro Developer Blog The option to demo your app at one of our Developer Q&A sessions An exclusive Miro Developers SWAG boxRequirementsApp must cover one of the community-inspired use cases and leverage at least one of our developer platform capabilities (Web SDK, REST API, Live Embed) App must be production-ready, working, and hosted publicly App must be submitted following the submission instructions belowSubmission InstructionsJoin the #community-app-contest channel in our Discord channel Post a link to your final, hosted project by the deadlineDeadlineThe submission deadline is October 14th Getting StartedJoin th

1
William Bishop
Mironeer
1 year ago
R
Rafael TurnesNew Here
posted in Developer platform and APIs

API: Get organization members does not return cursor

I'm trying to get all members of an organization.we have more than 100 users in the organization. I've downloaded the CSV to double-check it. we have an enterprise planExpected:limit of 100 users per request cursor field in JSON response for the subsequent requestIssue:there is no cursor field in the JSON response. It only returns when I use the query cursor in the request. Maybe it should return next_cursor or always return cursor. To make the pagination work, I had to get the ID of the last user in the array and set the cursor in the query. My suggestion here is to have a section in the documentation explaining how the pagination works. I've seen it in other documents. there is an unexpected/undocumented field, "type": "cursor-list"Documentation:https://developers.miro.com/reference/enterprise-get-organization-memberst's quite strange to have a query object than a typical query. I've tried a standard query, and it worked. I guess that the documentation needs to update. It's creatin

4
Addison Schultz
Mironeer
1 year ago
Matthias.Cullmann
Matthias.CullmannContributor
posted in Developer platform and APIs

IDs inconsistent across REST API endpoints

ProblemCall https://developers.miro.com/reference/get-logs → the https://developers.miro.com/reference/log-object yields a board ID like 3074457347733873980 Calling https://developers.miro.com/reference/get-board with that ID fails. Here we need to use the short ID o9J_ktAiH3s=Possible solutionsMake get-board accept long form of the id publish shortening algorithm / API

9
S
1 year ago
S
Siddhant MagoBeginner
posted in Developer platform and APIs

Maximum duration for get logs API

Is there a limit to the duration for which we can get the audit logs events using the getLogs API. For example, if I wanted to get all the events from 1st January 1970 to now, would I be able to do that? or is there an upper limit to the duration for which the audit logs are stored on Miro’s end?

1
Addison Schultz
Mironeer
1 year ago
M
Maxim HuryanovContributor
posted in Developer platform and APIs

How to get clipboard data when click the button?

HiI’m trying to get the clipboard data when I click the button on the miro plugin.I used this code for get clipboard data.document.addEventListener('paste', event => createStickyNote(event))function createStickyNote(event) {      var text = e.clipboardData.getData('Text');      console.log(text)}It works when I press Ctrl+V.but I want to get the clipboard data when I click the button.Please let me know your ideas,Thank you

9
M
1 year ago
M
Maxim HuryanovContributor
posted in Developer platform and APIs

Is it impossible to select the widgets on SDK V2?

Hi everyoneI noticed that it’s impossible to use miro.board.selection.selectWidgets() on Web SDK v2.How can I select the widgets on Web SDK v2.Please let me know your thought.Thank you 

3
Addison Schultz
Mironeer
1 year ago
M
Maxim HuryanovContributor
posted in Developer platform and APIs

How to set viewport for multiple sticky note?

Hi everyoneI have to set the viewport for multiple widgets.As you can see on this video, when I click the button, the board viewport have to change.Well it works on SDK 1.1 now.I used this code for get left, top, right and bottom value.But on SDK 2.0, the left, top, right, bottom parameter is no longer available.Please let me know how can I fix this issue.Thank you 

1
Addison Schultz
Mironeer
1 year ago
M
Maxim HuryanovContributor
posted in Developer platform and APIs

Fastest way to update web sdk 1.1 app to 2.0

Hi everyone.I need to update miro web sdk 1.1 app to 2.0I want to know how I can do this as soon as possible.Please let me know your ideas.Thank you

7
C
Mironeer
1 year ago
L
Lizelle NiitBeginner
posted in Developer platform and APIs

Loading images from private server

I am using the REST API to upload images to Miro automatically, but I can only figure out how to do this from a public server. I’d like to know if it’s possible to do this while keeping the data completely private. I am doing a data science project where I am automatically generating reports for sports players based on their performance data. I am generating the reports on Miro so that my client can edit them before exporting to pdf. I have a large number of plots, which I need to put on Miro automatically when a python script is run. My script works great when I use publicly accessible URLs on my personal website, but now we’re starting to work with sensitive data, so that’s not ideal. I know it’s unlikely that anyone is going to find unlisted images on a tiny website, but I need to be able to reassure my client that their data is very safe. Hence my search for a way to use a private server.Initially I tried uploading from my hard drive, but this turned out not to be possible (unless

2
Addison Schultz
Mironeer
1 year ago
Terms & Conditions