Getting Started

Welcome to Heron! This guide will help you make your first API request and understand the core workflow of our platform.

1. Get your API Credentials

Before you can use the Heron API, you need to obtain an API Key.

1. Log in to the Heron Dashboard.
2. Navigate to Developers > API Keys.
3. Click Create New Key.
4. Copy your secret key and store it safely. You won't be able to see it again!

2. Make your first API Call

Heron uses standard REST principles. You can interact with our API using any HTTP client (like curl, Postman, or your favorite programming language).

Replace YOUR_API_KEY with the key you generated in the previous step:

curl -X GET https://dev.api.tryheron.com/v1/users \
  -H "X-API-Key: YOUR_API_KEY"

3. Understand the Response

A successful response will return a list of users in your organization in JSON format:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "jane@example.com",
      "fullName": "Jane Doe",
      "roles": ["admin"],
      "status": "ACTIVE",
      "createdAt": "2024-04-15T08:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1
  }
}

4. Next Steps

Now that you've connected to Heron, you can explore more advanced features:

• Set up Authentication — Learn about different auth methods.
• API Reference — Explore every endpoint in detail.
• Guides — Learn about fund movements, entities, and more.