Crear y proteger una clave de API

What you'll achieve

Create a key so another tool (your website, your CRM, your automation) can connect to your Archie Send account, and protect it with an expiration date, a request limit and the IP addresses it can be used from.

Before you start

• Sign in with a user who can manage users (for example, Administrator).
• Decide what the other tool needs to do (only read contacts, add contacts, send transactional emails…). First create a role with only those permissions in Users → User roles: a key can only do what its role allows.

Step 1: create the key

1. Go to Users → Users and click New.
2. Choose the type API, enter a username (for example, online-store) and select the role from the previous step.
3. Click Save.
4. Copy the key that appears. It's only shown once: save it in your password manager. If you lose it, create another key.

Screenshot: window with the API key shown only once

Step 2: set limits on the key

1. In Users → Users, open the key (pencil).
2. In Limits for this key set:

• Requests per minute: between 10 and 1,200. The default is 120.
• Expires on: a date. The key stops working at the end of that day (Colombia time). Empty = doesn't expire.
• Allowed IP addresses: one per line (ranges like 10.0.0.0/8 too). Empty = from any address.

1. Click Save. Changes take effect immediately.

Screenshot: “Limits for this key” section with usage for the last 30 days

How to use it

Send the key with every request in the header Authorization: token USER:KEY, where USER is the key's username.

Expected result

• The user list shows, under each key, when it was last used and when it expires.
• In the key you see the requests and errors for the last 30 days.

Common issues

When to contact support

If you think someone used your key without permission, deactivate it immediately and write to us with the key's username and the approximate time (never send the key).