api-reference

Authentication

Last updated Invalid Date

Authenticate to Tipe with your API Keys.

Finding your API Keys

In the Tipe Dashboard, click the API Keys icon on the left sidenav:

API Keys Icon

This opens the API Keys interface. The Org Secret and myKey fields are what you'll use to connect your app to Tipe. The Org Secret allows us to get your Org data while the API key, myKey, makes sure you can request the data. These two keys are sensitive, so be sure to keep yours private.

API Keys UI

You create an API Key for each client so you can easily revoke them later if you wanted to.

To connect to Tipe, add these two keys to your .env, by replacing ADD YOUR ORG ID with your Org Secret and ADD YOUR API KEY with myKey:

undefined
TIPE_ID=ADD YOUR ORG ID
TIPE_API_KEY=ADD YOUR API KEY

The TIPE_ID is your Org, and the TIPE_API_KEY allows a particular client to use the API.

.env.sample in the Tipe Starters

The Tipe starters for React, Vue, and Angular have a file to get you started. In the root of each Starter, look for a file called .env.sample in the root of each project. For your convenience, the .env.sample files are at the following locations:

Upcoming: We are currently working on a feature to allow you to restrict which IP addresses can request data from an API Key.


Still have questions?

If these Authentication docs haven't answered all your Tipe Authentication questions, email us at support@tipe.io or start a chat with us in the Tipe Dashboard. We're always working on our docs and welcome suggestions.