Step 1: Sign Up and Get Your API Key
Before you can interact with our APIs, you’ll need to sign up for an account and obtain your unique API key.- Sign Up: If you haven’t already, create an account here.
- Access Dashboard: Once signed in, navigate to the settings section of the dashboard (near the bottom!)
- Generate API Key: In the settings, look for the area titled “API Keys.” Generate a new API key.
- Important: Keep your API key secure and do not share it publicly. Treat it like a password. When interacting with most of our general APIs, you will typically pass this key in an
X-API-KEYheader.
Step 2: Choose Your Preferred Language/Tool
Our API is designed to be language-agnostic, meaning you can use it with any programming language or tool that can send HTTP requests. Here are some common options:- cURL: For quick command-line testing.
- Python: Ideal for scripting and backend applications.
- JavaScript (Node.js/Browser): Great for web applications.
Step 3: Make Your First API Call
Let’s make a simple call to verify your setup. We’ll use the/api/account/get-display-name endpoint as an example, which retrieves the display name of the currently authenticated user.
Using cURL (Command Line)
Open your terminal or command prompt and run the following command. ReplaceYOUR_API_KEY with the actual API key you obtained in Step 1.
Using Python
Create a new Python file (e.g.,first_call.py) and add the following code:
Using JavaScript (Browser fetch)
This example demonstrates how to call the API from a web application using fetch. Replace YOUR_API_KEY with your actual API key.
Expected Response
If the call is successful and a display name is available, you should receive a JSON response similar to this:What’s Next?
Congratulations! You’ve successfully made your first API call using your API key. Now you’re ready to:- Explore the API Reference: Dive deeper into all available API endpoints.
- Read Guides: Learn about specific use cases and advanced topics in our Guides section.
- Understand Core Concepts: Get a better grasp of our platform’s underlying principles.