Start here with the Amino Engine API
What you can do with the API, which key and which article go with each job, and how to send your first event in five minutes.
Where it is in the app
Open Home, choose Settings, then General › API keys.
- Home
- Settings
- General
- API keys
The API lets your own code talk to Amino Engine. Your server tells us what happens in your store, and we run your flows, emails and texts from it. Your own AI can also read and build in your account through a second, separate door.
If you run WooCommerce or Shopify, you probably do not need the API. Use the store connection instead (see "Connect your store"). This section is for a store that is your own code, a portal, a script, or an AI.
#Which job needs which article
| You want to | Read this | Key |
|---|---|---|
| Send orders, carts and sign-ups from your own store | "Connect a custom-built store with the API" | Server key, ae_live_ |
| Track page views in the browser | The "Browser tracking" part of the same article | Public key, ae_pub_ |
| Send one email from your code (a receipt, a shipping notice) | "Send a receipt from your own code" | Server key |
| Email someone a login code or sign-in link | "Email somebody a login code" | Server key |
| Let an AI build flows and emails | "Agents and the API" | Agent key, ae_agent_ |
| Let an AI work on your ad accounts | "Connect your AI to your ad accounts" | Sign-in, no key |
| Make or edit ad links from an AI | "Agent addresses, tools and errors" | Agent key |
"Which key do I use?" explains the key types.
#Your first event in five minutes
Go to Settings → General → API keys and press Create key. Copy the key that starts with
On screenSettings › General › API keysae_live_. It is shown once.Keep it on your server in an environment variable. Never put it in a web page.
Check the key works: send a signed
GETtohttps://app.aminoengine.com/api/v1/ping. A good answer is200with"ok": trueand your brand's name.Send one event, such as
product_viewed, tohttps://app.aminoengine.com/api/v1/events.Open Settings → Other → Integrations. Under "What your shop is sending", your event name shows with a count.
On screenSettings › Other › Integrations
Every request with a server key must be signed. The signature is a hash of the time and the body, made with your key. The long article explains it with a copy-and-paste helper in Node and the same thing in curl.
#The rules that apply to every request
- Requests go to
https://app.aminoengine.com. - Bodies and answers are JSON.
- A request with a wrong or missing signature, or a clock more than 5 minutes out, gets
401. - Over a limit you get
429and aRetry-Afterheader. Wait that many seconds. - Money is in whole cents.
#Getting help
Every refusal is a sentence that says what to change. Each article ends with "If it didn't work".