Replicate Multiple Miro Accounts via the CData Sync CLI

CData Sync for Miro is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Miro connections. In this article we show how to use the CLI to replicate multiple Miro accounts.

Configure Miro Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Miro accounts, use multiple configuration files. Below is an example configuration to replicate Miro to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
  <DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';</ConnectionString>
  <ReplicateAll>False</ReplicateAll>
  <NotificationUserName></NotificationUserName>
  <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
  <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
  <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';</ConnectionString>
  <ReplicateAll>False</ReplicateAll>
  <NotificationUserName></NotificationUserName>
  <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Using API Key Authentication

Miro uses API Key authentication with an access token. To generate an access token:

1. Log in to your Miro account
2. Navigate to Settings > Your apps
3. Click "Create new app" or select an existing app
4. Configure the required permissions (e.g., boards:read, teams:read)
5. Install the app and generate an access token
6. Copy the generated access token (it will only be shown once)

After obtaining your access token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your access token.

Connecting to Miro

Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.

Configure Queries for Each Miro Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Miro API. The statement below caches and incrementally updates a table of Miro data:

REPLICATE Boards;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Miro accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Boards SELECT * FROM Boards 

Alternatively, you can use a different schema:

REPLICATE PROD.Boards SELECT * FROM Boards

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

APISync.exe -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql