Authorization

Get Your API Keys

To make requests against the Alloy Embedded APIs, you’ll need to login to your Alloy Embedded account and located the API Keys tab under Settings. From here, you'll notice there are two types of API Keys to generate:

  • Development Key
  • Production Key

The development and production keys are effectively identical with a minor caveat: Users created using the development key will be sandboxed to that environment. Because Embedded relies heavily on the concept of users, you can use your development key to generate as many test accounts as you like without congesting your production environment. When you're ready, you can easily swap keys to production.

Using Alloy Embedded API Keys

To use our API key in your reuests, include the key in the Authentication header as a bearer token. Other parameters can be added as specified in the API reference.

curl <alloy-endpoint>
   -H "Accept: application/json"
   -H "Authorization: Bearer <API KEY>"
const request = require("request");

request(
  {
    url: "<alloy-endpoint>",
    headers: {
      Authorization: "Bearer <API KEY>",
    },
  },
  function (err, res) {
    if (err) {
      console.error(err);
    } else {
      console.log(res.body);
    }
  }
);


Key Security

You should always closely guard your production key. When you click the Generate button, the production API key will be shown once. You should make sure to securely store this key as it will not be shown again. The Production API key is generated, it is only visible once and cannot be decoded

If you click the Generate button again, Alloy Embedded will revoke the previous key and generate a new one.

🚧

Production Key Security

Production keys should be treated with the utmost care. If someone acciedntally accesses your production key, they can make requests on behalf of your entire Embedded account. That's why we reccommend never sharing this key with anyone else and storing it in a secrets manager.


Alloy IP Addresses

Several apps, including many database blocks require you access them only via an IP Whitelist. If you are planning to stream data to a data warehouse or database, you may need to whitelist our IP address.

You can find our static IP address for the Alloy servers here: 3.211.13.53


Did this page help you?