Skip to main content

Getting Started

This guide will help you get up and running with the Rails Services API quickly and efficiently.

Prerequisites​

Before you begin, make sure you have:

  • A valid Rails Services account
  • API credentials (API key and secret)
  • Basic knowledge of REST APIs
  • HTTPS-enabled endpoints for production integrations

Authentication​

All API requests require authentication using API keys. We support two authentication methods:

API Key Authentication​

Include your API key in the request headers:

X-API-KEY: your_api_key_here
Authorization: Bearer your_jwt_token_here

JWT Token Authentication​

For most endpoints, you'll need both an API key and a JWT token:

curl -X POST https://api.ledgerlink.ai/v1/auth/login \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your_email@example.com",
    "password": "your_password"
  }'

Base URLs​

Our services are available at the following base URLs:

  • Production API: https://api.ledgerlink.ai
  • Sandbox API: https://sandbox-api.ledgerlink.ai

Your First API Call​

Let's start with a simple health check to verify your connection:

curl -X GET https://api.ledgerlink.ai/v1/health \
  -H "X-API-KEY: your_api_key"

Expected response:

{
  "status": "App is OK and running"
}

API Versioning​

All APIs are versioned using URL path versioning. The current version is v1:

https://api.ledgerlink.ai/v1/...

Rate Limiting​

To ensure fair usage, our APIs implement rate limiting:

  • Standard tier: 1000 requests per hour
  • Premium tier: 10000 requests per hour
  • Enterprise tier: Custom limits

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Response Format​

All API responses follow a consistent format:

Successful Response​

{
  "data": {
    // Response data here
  },
  "pageInfo": {
    "limit": 20,
    "offset": 0,
    "total": 100
  }
}

Error Response​

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request parameters are invalid",
    "details": [
      {
        "field": "email",
        "message": "Email is required"
      }
    ]
  }
}

Testing Your Integration​

We provide a comprehensive sandbox environment for testing:

  1. Use sandbox URLs for all testing
  2. Test data is reset daily at midnight UTC
  3. HTTPS endpoints are required for production integrations
  4. API keys for sandbox are separate from production

Next Steps​

Now that you're familiar with the basics:

  1. Explore the API Reference - Learn about available endpoints
  2. Review Error Handling - Handle errors gracefully
  3. Contact Support - Get assistance with your specific integration needs

Common Integration Patterns​

PFI (Payment Financial Institution) Integration​

If you're integrating as a PFI:

  1. Register your participant details
  2. Set up custodian bank accounts
  3. Configure transaction endpoints
  4. Implement compliance workflows

Custodian Bank Integration​

If you're integrating as a custodian bank:

  1. Configure participant management
  2. Set up transaction monitoring
  3. Implement balance management
  4. Configure compliance workflows

Need help? Check our FAQ or contact our support team.