Skip to main content

Quick Start Guide

Get up and running with the Brighty API in minutes.

Authentication​

Learn how to authenticate with the Brighty API using API tokens.

Overview​

Brighty API uses API tokens for authentication. All API requests must include a valid API token in the Authorization header.

Getting Your API Token​

Authentication Setup Flow​

Step 1: Access Business Portal​

  1. Log in to business.brighty.app
  2. Navigate to business.brighty.app/account/business
  3. Find the "API Tokens" section

Step 2: Create API Token​

  1. Click "Create API Token" or similar button
  2. Copy the generated token
  3. Store the token securely

API Environments​

  • Production: https://api.brighty.app
  • Test/Sandbox: https://api.brighty.codes

Test vs Production Tokens​

  • Test Environment: Ask your manager to provide you with test api token
  • Production Environment: Requires completed KYC and business verification

Using Your API Token​

Include the API token in all API requests using the Authorization header:

curl -X GET https://api.brighty.codes/business/v1/accounts \
  -H "Authorization: Bearer $BRIGHTY_APT_TOKEN"

Security Best Practices​

1. Store Tokens Securely​

  • Never commit API tokens to version control
  • Use environment variables or secure vaults
  • Rotate tokens regularly

2. Use HTTPS Only​

  • All API calls must use HTTPS
  • Never send tokens over HTTP

3. Handle Errors Properly​

  • Check HTTP status codes in responses
  • Handle 401 (Unauthorized) and 403 (Forbidden) errors
  • Implement retry logic for temporary failures

Error Response Example​

{
  "errorCode": 401,
  "name": "Unauthorized",
  "description": "Invalid API token provided"
}

Testing Your Authentication​

Quick Test​

Test your API token with a simple API call:

# Test environment
curl -X GET https://api.brighty.codes/business/v1/accounts \
  -H "Authorization: Bearer $BRIGHTY_APT_TOKEN"

# Production environment
curl -X GET https://api.brighty.app/business/v1/accounts \
  -H "Authorization: Bearer $BRIGHTY_APT_TOKEN"

Successful Response:

{
  "accounts": [
    {
      "id": "5b1175bc-2c31-4f94-a14f-284deafa6074",
      "name": "Main EUR",
      "balance": {
        "amount": "5611.04",
        "currency": "EUR"
      },
      "type": "CURRENT",
      "openedAt": "2024-02-26T10:08:04.454Z"
    }
  ]
}

Failed Authentication:

{
  "errorCode": 401,
  "name": "Unauthorized",
  "description": "Invalid API token provided"
}

Next Steps​

Now that you have a working integration:

  1. Explore Card Management - Learn advanced card features
  2. Set up Transfers - Enable money movement
  3. Browse API Reference - Explore all available endpoints

Support​

Need help? We're here for you:

  • 💬 Chat: Available in your business dashboard
  • 📖 Documentation: You're reading it!
  • 📧 Email: support@brighty.app