# Onboarding Guide

This guide walks you through setting up your Transportial platform from scratch — from registration to your first planned transport.

## 1. Register Your Account

Start by creating your account and platform:

**Portal registration:** [portal.otms.transportial.com/auth/register](https://portal.otms.transportial.com/auth/register)

**Developer registration:** [portal.otms.transportial.com/auth/developer/register](https://portal.otms.transportial.com/auth/developer/register)

Or register via the API:


```bash
curl -X POST https://api.otms.transportial.com/api/user/register \
  -H "Content-Type: application/json" \
  -d '{
    "type": "USER",
    "accountType": "PLANNING",
    "firstName": "Jane",
    "lastName": "Doe",
    "username": "jane@acme-logistics.com",
    "email": "jane@acme-logistics.com",
    "password": "secure-password",
    "repeatPassword": "secure-password",
    "termsAndConditions": true
  }'
```

This creates your **user**, **platform**, and initial configuration.

## 2. Log In and Get Your Token


```bash
curl -X POST https://api.otms.transportial.com/api/user/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "jane@acme-logistics.com",
    "password": "secure-password"
  }'
```

Save the `access_token` from the response — you'll use it in the `Authorization: Bearer` header for all subsequent calls.

## 3. Set Up Your Business

Create your company profile:


```bash
curl -X POST https://api.otms.transportial.com/api/business \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Acme Logistics B.V.",
    "relationType": "carrier",
    "coc": "12345678",
    "vat": "NL123456789B01",
    "website": "https://acme-logistics.com",
    "locations": [
      {
        "name": "Headquarters",
        "address": {
          "street": "Transportweg 1",
          "city": "Rotterdam",
          "postalCode": "3011 AA",
          "country": "NL"
        }
      }
    ],
    "contactDetails": [
      { "type": "email", "value": "ops@acme-logistics.com" },
      { "type": "phone", "value": "+31 10 123 4567" }
    ]
  }'
```

Create additional businesses for your customers and partners — they'll be referenced in transport orders.

## 4. Add Your Fleet

Register vehicles that will execute transports:


```bash
curl -X POST https://api.otms.transportial.com/api/vehicle \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Truck NL-AB-12",
    "licensePlate": "NL-AB-12",
    "type": "truck"
  }'
```

## 5. Add Chauffeurs

Register your drivers:


```bash
curl -X POST https://api.otms.transportial.com/api/chauffeur \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "firstName": "Peter",
    "lastName": "de Vries"
  }'
```

## 6. Create Your First Transport Order

Now you have everything to create and plan a transport:


```bash
curl -X POST https://api.otms.transportial.com/api/transportOrder \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Shipment RTD-AMS #001",
    "status": "requested",
    "consignments": [
      {
        "status": "requested",
        "goods": [
          {
            "type": "items",
            "description": "Consumer electronics",
            "quantity": 50,
            "weight": { "value": 1200, "unit": "kg" }
          }
        ]
      }
    ]
  }'
```

## 7. Install Apps (Optional)

Extend your platform with integrations from the App Store:


```bash
# Browse available apps
curl -X GET "https://api.otms.transportial.com/api/app-store/browse/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

# Install an app
curl -X POST "https://api.otms.transportial.com/api/app/{appId}/install" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

See the [App Store guide](/guides/app-store) for details on available integrations.

## What to Explore Next

| Area | Description | Guide |
|  --- | --- | --- |
| Core concepts | Transport orders, consignments, trips, actions | [Concepts](/guides/concepts) |
| App Store | Integrations and automations | [App Store](/guides/app-store) |
| API Reference | Full endpoint documentation | [API Reference](/apis) |


## Platform Settings

Your platform has configurable settings that control behavior across the system:

- **UI settings** — Branding, default views
- **Financial settings** — Currency, tax defaults, approval flows
- **Pricing settings** — Rate calculation rules
- **Translation settings** — Language preferences
- **Alert settings** — Notification rules and channels
- **Customer portal settings** — Self-service portal configuration


These are managed through the platform administration panel or via the `/platform/settings` API endpoints.