Back to Documentation

Getting Started Guide

Step-by-step guide to start using the Blox API

1

Create an Account

Sign up for a Blox API account to get started.

Sign Up
2

Create an Application

Create an application to organize your API usage. Each application can have multiple API keys.

Sign in to create an application

3

Generate an API Key

Generate a sandbox or production API key for your application.

Sign in to generate an API key

4

Make Your First API Call

Test your API key by calling the health check endpoint:

curl https://api.blox.api/api/health

Or get information about your application:

curl -X GET https://api.blox.api/api/v1/me \
  -H "X-Blox-Api-Key: YOUR_API_KEY_HERE"
5

Explore Modules

Each module requires a license. Check available modules and their endpoints:

curl -X GET https://api.blox.api/api/v1/modules \
  -H "X-Blox-Api-Key: YOUR_API_KEY_HERE"

Next Steps