Get your API credentials

You sign in to the API with a login email and a key. You create them on the Developers page of the outlet portal. The page is titled Connect your billing software.

Before you start#

• You can sign in to the outlet portal.

• You have somewhere safe for the key, such as a password manager or your software team’s secrets store.

1. 1

   Step 1: Open Developers

   Choose Developers in the left menu. The card Your key shows your login email and when the key was created. For safety, the key itself is never shown again.

   

   

   Close

2. 2

   Step 2: Create the key

   If you have no key yet, the card says You have not created a key yet. Press Create my key. The box Your key is ready opens.

3. 3

   Step 3: Copy it now

   The box shows Login email and Key. It warns: you will not see this key again. Copy both. Download as CSV (email and key) gives you one file to hand to your software team. The box also shows the Address of the practice server, which uses the same login email and key, and a link Open the guide for your software team. Press I have saved my key when you are done.

4. 4

   Step 4: Share the setup guide

   Further down, Send the setup guide to your developer has Download guide (.md) and Share guide. The guide has what to build and the full API documentation. It does not include your key: send the key separately.

   

   

   Close

5. 5

   Step 5: Log in from code

   Send the login email and the key to POST /auth/api/login. See Quickstart.

Make a new key#

Press Make a new key if the key is lost or has leaked. The portal asks you to confirm: your software stops working until you update it with the new key, and the old key stops working right away. Press Make a new key to confirm, or Keep my current key to cancel.

Errors when you log in#