Skip to main content

Quick Start Guide

Welcome to AttuneLogic! This guide will help you get started with our powerful logistics and service management API in just a few minutes.

What is AttuneLogic?​

AttuneLogic is a comprehensive multi-tenant API platform designed for:

  • 🚛 Trucking & Logistics: Load management, driver tracking, route optimization
  • 🔧 Service & Repair: Job scheduling, technician management, customer portals
  • 🏠 HVAC, Plumbing, Electrical: Specialized industry workflows

Prerequisites​

Before you begin, you'll need:

  • A valid AttuneLogic account (Sign up here)
  • API credentials (API key and secret)
  • Basic knowledge of REST APIs
  • A tool for making HTTP requests (curl, Postman, or your preferred HTTP client)

Step 1: Get Your API Credentials​

  1. Log into your AttuneLogic Dashboard
  2. Navigate to Settings → API Access
  3. Click Generate New API Key
  4. Copy your API Key and API Secret (store these securely!)
Important

Your API secret will only be shown once. Make sure to save it in a secure location.

Step 2: Authenticate​

All API requests require authentication using your API credentials. AttuneLogic uses JWT-based authentication.

Get an Access Token​

curl -X POST https://api.attunelogic.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your_api_key_here",
    "apiSecret": "your_api_secret_here"
  }'

Response:

{
  "success": true,
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expiresIn": 3600,
    "user": {
      "id": "user_123",
      "email": "you@company.com",
      "role": "admin"
    }
  }
}

Use the Access Token​

Include the access token in all subsequent API requests:

curl -X GET https://api.attunelogic.com/api/v1/jobs \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Step 3: Make Your First API Call​

Let's create your first job to see the API in action:

curl -X POST https://api.attunelogic.com/api/v1/jobs \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First Job",
    "description": "Testing the AttuneLogic API",
    "status": "pending",
    "priority": "medium",
    "scheduledDate": "2024-01-15T10:00:00Z"
  }'

Response:

{
  "success": true,
  "data": {
    "id": "job_abc123",
    "title": "My First Job",
    "description": "Testing the AttuneLogic API",
    "status": "pending",
    "priority": "medium",
    "scheduledDate": "2024-01-15T10:00:00Z",
    "createdAt": "2024-01-10T09:30:00Z",
    "updatedAt": "2024-01-10T09:30:00Z"
  }
}

🎉 Congratulations! You've successfully created your first job using the AttuneLogic API.

Step 4: Explore Your Industry​

AttuneLogic is designed specifically for different industries:

🚛 Trucking & Logistics​

  • Load management and dispatch
  • Driver tracking and HOS compliance
  • Route optimization
  • Fleet management

🔧 Service & Repair​

  • Job scheduling and dispatch
  • Technician management
  • Customer portals
  • Equipment tracking

🏠 HVAC, Plumbing, Electrical​

  • Emergency service dispatch
  • Parts inventory management
  • Service agreements and warranties
  • Maintenance scheduling

Industry-specific guides are coming soon!

Next Steps​

Now that you're set up, here's what to explore next:

  1. Authentication - Learn about token management and security (coming soon)
  2. API Reference - Explore all available endpoints (coming soon)
  3. Rate Limits - Understand API usage limits (coming soon)
  4. Integrations - Connect with your existing tools (coming soon)

Need Help?​

Pro Tip

Start with our industry-specific guides to see real-world examples tailored to your business needs!