Connecting to ReportMagic

To connect to ReportMagic so you can use ReportMagic macros, follow the steps below.

Note that in the documentation, a 'Magic Suite Connection' is synonymous with a 'ReportMagic Connection'. The apps' user interfaces currently use the term 'ReportMagic Connection'.

1. In the Admin app, go to the API Tokens page OR
2. In ReportMagic, go to Admin > API Tokens
3. Click the Add button and enter any name for an API Token but do not yet click Create. You will need the Token name and API Key in a moment and these are only shown once when creating the token
4. In a second browser tab:
• In the Admin app, click Connections OR
• In ReportMagic, go to Admin > Connections
• Click the Create button to add a Connection and choose the type 'ReportMagic' from the drop-down
• Enter a name - we recommend that you use "Default" for the name of the first Connection of each type, and optionally, a description
• In the URL field, enter the API URL for your token, for example https://​api​.reportmagic​.net
5. From the first browser tab, click Copy next to the name of the API Token and paste it in the second browser tab, in the Username box
6. From the first browser tab, click Copy next to the API Key - this will look something like a70a1234-bc56-3vf1-f9ds-12wf1234e5f7 - and paste into the second browser tab in the Password field
7. On the first browser tab, click Create to create the API Token
8. On the second browser tab, click Create to create the Connection

You can now use various ReportMagic macros in report templates, such as the [ReportMagic.ScheduleList:] macro.