Skip to main content

Getting Started

This guide will help you get up and running with the Link Router API quickly and efficiently.

Prerequisites​

Before you begin, make sure you have:

  • Access to the Link Router service
  • Basic knowledge of REST APIs
  • HTTPS-enabled endpoints for production integrations

Base URLs​

Our services are available at the following base URLs:

  • API: <link_router_host>

Your First API Call​

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

curl -X GET <link_router_host>/health \

Expected response:

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

Response Format​

All API responses follow a consistent format:

Successful Response​

{
  // Response data here
}

Error Response​

{
  "statusCode": 400,
  "error": ["description of the error"],
  "requestId": "c2f1e8a2-7b3a-4e2a-9c1d-123456789abc",
  "path": "path to the endpoint",
  "timestamp": "2025-11-20T16:32:57.915Z"
}

Testing Your Integration​

We provide a comprehensive sandbox environment for testing:

  1. HTTPS endpoints are required for production integrations

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

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