Features explained

API keys, explained without code

What the keys on the API Keys page are for and how to keep them safe.

An API key is a long code that lets another program, usually your website, send contacts into Miaalo. Think of it as a password for machines. You don't need to understand code to manage your keys.

The API Keys menu item only appears if your account has API access. If you don't see it and need it, email info@fairshare.tech.

The two kinds of key

Source API keyUser API key
What it can doOnly add contacts to the sources you choseCreate new sources in your account
Who should see itSafe to put on your websiteKeep secret. Only for your developer's server
Where to find itThe Source API Key tabThe User API Key tab. Click the title to reveal it
How you get oneCreated automatically with every new source, or with Add Source API KeyCreated with your account
API Keys page with the Source API Key and User API Key tabs
The API Keys page. Keys are hidden in this picture.

Add a source API key yourself

Each source already gets a key automatically. Add another one when you want a separate key per website or form.

  1. Open API Keys and click Add Source API Key.
  2. Title: a name for you, for example Homepage form.
  3. Origin: where the key will be used, usually your website address, for example https://www.example.com. It must be different from every other key's origin. It does not stop other websites from using the key.
  4. Sources: pick the source(s) new contacts should go into.
  5. Click Add. The new key appears in the list.
Add Source API Key form with Title, Origin and Sources fields
The Add Source API Key form.

Edit or delete a key

  • Edit changes the title, origin or sources. The key itself stays the same, so your website keeps working.
  • Delete stops the key immediately. Any website using it will stop sending contacts. This can't be undone.

Think your user API key has leaked? There is no button to replace it yet. Email info@fairshare.tech straight away.