BDM Universal API

Step 1: Import Collection

1. 1

   Open Postman and click Import button

2. 2

   Drag and drop the downloaded JSON file, or click Upload Files

3. 3

   Click Import to add the collection to your workspace

Step 2: Configure Variables

Set your base URL and credentials:

1. 1

   Click on the collection name → Variables tab

   base_url: http://localhost:8000 (change to your domain)

   auth_token: Leave empty (auto-filled after login)

Step 3: Test Authentication

1. 1

   Open Authentication → Login request

2. 2

   Update the request body with your credentials:

   {
     "email": "your-email@example.com",
     "password": "your-password"
   }

3. 3

   Click Send. The auth token will be automatically saved!

Login

curl -X POST http://localhost:8000/api/login \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "password"
  }'

Save the token from the response to use in subsequent requests.

List Resources (with Authentication)

curl -X GET http://localhost:8000/api/v1/accounting/invoices \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

List with Filters & Pagination

curl -X GET "http://localhost:8000/api/v1/accounting/invoices?page=1&per_page=20&filter[status]=unpaid&sort_by=due_date" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

Create Resource

curl -X POST http://localhost:8000/api/v1/accounting/invoices \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -d '{
    "customer_name": "Acme Corp",
    "customer_email": "billing@acme.com",
    "total": 1500.00
  }'

Update Resource

curl -X PUT http://localhost:8000/api/v1/accounting/invoices/1 \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -d '{
    "customer_name": "Acme Corporation"
  }'

Delete Resource

curl -X DELETE http://localhost:8000/api/v1/accounting/invoices/1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

Guest Access (No Authentication)

curl -X GET http://localhost:8000/api/guest/resource/YOUR_GUEST_TOKEN_HERE \
  -H "Accept: application/json"

1. User Authentication (Sanctum)

Standard login for web and mobile apps:

# Login
POST /api/login
{
  "email": "user@example.com",
  "password": "password"
}

# Response
{
  "success": true,
  "data": {
    "token": "1|abc123def456...",
    "user": {...}
  }
}

# Use token in subsequent requests
Authorization: Bearer 1|abc123def456...

2. API Token Authentication

For service-to-service communication:

# Create token first (via authenticated request)
POST /api/tokens
{
  "name": "My Integration",
  "scopes": ["accounting.*"]
}

# Response includes token (save it!)
{
  "data": {
    "token": "bdm_xyz789..."
  }
}

# Use in requests
Authorization: Bearer bdm_xyz789...

3. Guest Access

Token in URL, no Authorization header needed:

GET /api/guest/resource/128_character_guest_token_here