Flic Platform API

Introduction

Welcome to the Flic Platform API documentation. The Flic Platform is a comprehensive solution for transport and logistics management, combining a powerful Laravel backend with responsive React frontends for web and mobile.

Architecture

The Flic Platform follows a modern, decoupled architecture with a RESTful API backend and separate frontend applications.

Authentication

All API requests must be authenticated using a Bearer Token. Include the token in the Authorization header of every request.

Authorization: Bearer YOUR_API_TOKEN

Obtaining a Token

To obtain an API token, send a POST request to the login endpoint with your credentials.

{
  "email": "demo@flicono.ai",
  "password": "your_password"
}

{
  "token": "1|abc123...",
  "user": {
    "id": 1,
    "name": "Demo User",
    "email": "demo@flicono.ai",
    "role": "admin"
  }
}

Wingcard Templates

Wingcard Templates define the structure and fields for task cards sent to drivers. Each template contains a blueprint that specifies required and optional fields.

{
  "data": [
    {
      "id": 1,
      "uuid": "abc-123-def",
      "name": "Standard-Transport",
      "category": "transport",
      "description": "Standard Transportvorlage",
      "is_active": true,
      "is_default": true,
      "blueprint": {
        "required_fields": ["reference", "pickup_address", "delivery_address"],
        "optional_fields": ["notes", "weight"],
        "field_config": { ... }
      }
    }
  ]
}

{
  "name": "Express Delivery",
  "category": "express",
  "description": "Template for express deliveries",
  "blueprint": {
    "required_fields": ["reference", "delivery_address", "signature"],
    "optional_fields": ["notes"],
    "field_config": {
      "reference": { "type": "input_text", "label": "Reference Number" },
      "delivery_address": { "type": "address", "label": "Delivery Address" },
      "signature": { "type": "input_signature", "label": "Recipient Signature" },
      "notes": { "type": "input_textarea", "label": "Notes" }
    }
  }
}

Hub Directory (XRM)

The Hub Directory is a unified entity management system for managing customers, drivers, suppliers, and other contacts.

{
  "type": "organization",
  "name": "Acme Logistics GmbH",
  "email": "info@acme-logistics.de",
  "phone": "+49 30 12345678",
  "tax_id": "DE123456789",
  "roles": ["customer"]
}

Wingcard Protocol v1.0

The Wingcard Protocol defines the structure of task cards used in the Flic ecosystem. Each Wingcard is based on a template blueprint.

Blueprint Structure

A blueprint is a JSON object with three main parts:

Element Types

The following element types are available for use in the field_config:

Information Elements

Input Elements

Code Examples

JavaScript / Node.js

const API_BASE = 'https://app.flicono.ai/api/v1';
const TOKEN = 'your_api_token';

// Fetch all templates
async function getTemplates() {
  const response = await fetch(`${API_BASE}/templates`, {
    headers: {
      'Authorization': `Bearer ${TOKEN}`,
      'Content-Type': 'application/json'
    }
  });
  return response.json();
}

// Create a new order
async function createOrder(data) {
  const response = await fetch(`${API_BASE}/orders`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${TOKEN}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
  });
  return response.json();
}

PHP / Laravel

use Illuminate\Support\Facades\Http;

$apiBase = 'https://app.flicono.ai/api/v1';
$token = 'your_api_token';

// Fetch all hub entities
$response = Http::withToken($token)
    ->get("{$apiBase}/hub/entities", [
        'type' => 'organization',
        'role' => 'customer'
    ]);

$entities = $response->json();

cURL

# Get all templates
curl -X GET "https://app.flicono.ai/api/v1/templates" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

# Create a new entity
curl -X POST "https://app.flicono.ai/api/v1/hub/entities" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"person","name":"John Doe","email":"john@example.com"}'