Skip to main content

​
Setup your API Key

Get your API key from the Bit2Connect dashboard to start making API calls. You’ll need an active subscription to access the API.
1

Create Account & Project

Sign up at dash.bit2connect.com and create your first project. Each project gets its own API key for isolated link management.
2

Choose & Activate Subscription

Select our Starter Plan ($29.99/month) to unlock unlimited dynamic links, advanced analytics, and full API access. This plan includes all core features for individual developers and small teams.
3

Navigate to API Settings

In your project dashboard, go to Settings → API Keys to manage your authentication credentials.
4

Generate API Key

Click Generate New API Key and copy the generated key. All Bit2Connect API keys start with b2co_ prefix for easy identification.
5

Test Your Key

Use the key immediately - no activation required. Each key is tied to your project and subscription plan limits.
Security Best Practices: Never expose API keys in client-side code, public repositories, or logs. Use environment variables in production and rotate keys regularly.

​
API Rate Limits

The Bit2Connect API implements rate limiting to ensure fair usage and optimal performance:
Current Rate Limit: 180,000 requests per hour for all API keys

​
Rate Limit Headers

Every API response includes rate limit information in the headers: 
X-RateLimit-Limit: 180000
X-RateLimit-Remaining: 179999
X-RateLimit-Reset: 2024-01-15T11:30:00.000Z
  • X-RateLimit-Limit: Total requests allowed per hour (180000)
  • X-RateLimit-Remaining: Requests remaining in current window
  • X-RateLimit-Reset: ISO timestamp when the rate limit resets

​
Handling Rate Limits

When you exceed your rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "API rate limit exceeded. Please try again later."
  }
}
Best Practices:
  • Monitor the rate limit headers in your responses
  • Implement exponential backoff when approaching limits
  • Cache responses when possible to reduce API calls
  • Distribute requests evenly throughout the hour
Rate limits are enforced per API key (180,000 requests/hour). The limit applies to all endpoints and resets every hour.

​
API Endpoints & Authentication

The Bit2Connect Public API uses version 1.0 for external integrations: 
# Base URL: https://api.bit2connect.com/1.0/
# Authentication: X-API-KEY header
curl -H "X-API-KEY: b2co_your_key_here" \
     https://api.bit2connect.com/1.0/links
This documentation covers the Public API (1.0) for external integrations and third-party applications.

​
Make your first API call

curl -X POST "https://api.bit2connect.com/1.0/links" \
  -H "X-API-KEY: b2co_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product 123 Link",
    "payload": {
      "link": "https://example.com/product/123",
      "android": {
        "package": "com.example.app",
        "store_fallback": "https://play.google.com/store/apps/details?id=com.example.app"
      },
      "ios": {
        "bundleId": "com.example.app",
        "app_store_fallback": "https://apps.apple.com/app/example-app/id123456789"
      },
      "social": {
        "title": "Check out this amazing product!",
        "description": "Discover the best deals on our mobile app",
        "image": "https://example.com/images/product-123.jpg"
      }
    },
    "expiresAt": "2025-01-15T10:30:00Z"
  }'

​
Understanding the Response

A successful response will look like this: 
{
  "success": true,
  "data": {
    "id": "clp123abc456",
    "code": "abc12345",
    "shortUrl": "https://b2co.link/abc12345",
    "originalUrl": "https://example.com/product/123",
    "name": "Product 123 Link",
    "status": "ACTIVE",
    "createdAt": "2024-01-15T10:30:00Z",
    "expiresAt": "2025-01-15T10:30:00Z",
    "clickCount": 0
  },
  "timestamp": "2024-01-15T10:30:00Z"
}
Visit the shortUrl from different devices to see Bit2Connect’s intelligent routing:
With App Installed: Opens directly in your app with deep link data Without App: Redirects to App Store, remembers intent for post-install deep linking

​
Advanced Features

Campaign Tracking

Add UTM parameters to track marketing campaign performance across channels.

A/B Testing

Create multiple links with different payloads to test user engagement and conversion rates.

Geographic Routing

Route users to different destinations based on their geographic location.

Time-based Links

Set expiration dates for time-sensitive campaigns and promotions.
Monitor your usage with the /usage endpoint to avoid hitting rate limits during peak traffic.

​
Next Steps

Link Management

Understanding dynamic link creation, validation, and best practices

API Reference

Dive deep into our complete API documentation