Dashboard overview
What this is for
The dashboard is the website where you manage your ClinikAPI account without writing code: create the API keys your software uses, watch the requests it makes, set up webhooks, look at practice records, and see how much of your plan you have used. These pages describe each screen exactly as it appears, in plain language, for people who have never used it (or a healthcare API) before. If you are new, start with Your first 10 minutes.Before you start
- You need a ClinikAPI account. See Sign in and sign up if you do not have one yet.
- Some actions depend on your role (owner, admin or member). Each page says who can do what; the table on Members summarizes it.
How it is organized
Everything belongs to an organization (your team or company), and an organization holds one or more projects. Keys and the records they create belong to a project. Webhooks, Logs, Realtime and Usage are opened from inside a project but show the whole organization’s activity, and members and organization settings live at the organization level.Pages in this section
Start here
Your first 10 minutes, and a glossary of every term.
Account and access
Signing in, the console layout, your profile, two-factor sign-in and deleting your account.
Organizations
Creating an organization, billing, settings, members, invitations and sub-organizations.
Projects and keys
Creating a project, API keys, webhooks, project settings, and compute and disk.
Working with data
The data browser, exports, realtime, logs, usage, the API reference and the FHIR server.
How each page is written
Every page follows the same pattern: what the screen is for, what you need before you start, numbered steps naming each button exactly as it appears, what you will see (including empty and error states), common questions, and a troubleshooting table of the messages you may meet.Common questions
Do I need to know FHIR?
Do I need to know FHIR?
No. FHIR is the healthcare data standard behind the API. The dashboard and these pages explain the few terms you need as you meet them.
Is it safe to experiment?
Is it safe to experiment?
Yes, with a test key. Test keys use a free practice environment (the sandbox) that is separate from real data. See Sandbox rules.
Where do I get help?
Where do I get help?
The help menu in the top bar has Documentation, System status and Contact support.