Skip to main content
This guide takes you from a new developer account to an app running inside the Max AI dashboard and calling the API. It uses the intramail API as the example. Until your app is approved, it runs only in the developer sandbox, an organization of generated test data, so you never touch a real clinic’s records while you build.
Prefer the command line? The Max AI CLI can create the app, start the tunnel and register it for you.

​
Before you start

You need Node.js 20 or later and cloudflared, which gives your local app a public HTTPS address the dashboard can load:
For Linux and Windows, see Cloudflare’s downloads page.
1

Create your app

Sign in at app.maxcare.ai and open the Developer Console. Click Create New App and fill in:
  • App Info: App Name and Category.
  • Version: a Version such as 0.1.0, and http://localhost:3000 as the App URL. You’ll replace it with your tunnel address in step 3.
  • Permissions: under Intramail, turn on read access (read:intramail).
Save the app.
2

Run the app template

Your app is now running at http://localhost:3000. Leave this terminal open.
The cp puts the App Bridge script in public/, which lets your app talk to the dashboard.
3

Give it an HTTPS address

In a second terminal:
Copy the https://….trycloudflare.com address it prints. In the Developer Console, open your app, click Edit Draft, paste the address into App URL, and click Save Draft.
You get a new address every time you restart cloudflared. Update App URL each time.
4

Open it in the developer sandbox

On your app’s page, click Test in developer sandbox. The dashboard switches to the sandbox and opens your app inside it. The sandbox also gives you your own mailbox of generated intramail.Click Back to Dev Portal to return to your own organization.
5

Create an API key

On your app’s page, open the API Keys tab:
  1. Click Create API Key, name it, select read:intramail, and click Create Key.
  2. Copy the key right away. It is only shown once.
  3. Copy the sandbox organization ID shown under the API Keys heading. Every request to the sandbox sends it.
Create a file named .env.local in your project folder:
.env.local
Keep your API key secret. Never put it in client-side code, a public repository or logs. If it leaks, revoke it and create a new one.
6

Make your first request

Load .env.local into your terminal, then check your mailbox’s status and read your messages:
Every request needs both headers: Authorization with your API key, and X-Organization-Id with the organization whose data you’re reading. Both calls should return "code": "success".

​
Troubleshooting

​
Next steps

When your app is ready, open your draft in the Developer Console and click Submit for Review. Once the Max AI team approves it, clinics can install it from the marketplace.

App Development

Use App Bridge and the UI components inside the dashboard.

Scopes

Which scopes grant access to which endpoints.

CLI Reference

Create, run and deploy apps from the command line.

Authentication

API keys, organization IDs and app tokens.