Skip to main content

Getting Started

Welcome to the Fuuffy API documentation! This guide will help you get started with integrating Fuuffy's logistics platform into your application.

Overview​

The Fuuffy API allows you to programmatically create and manage orders, track packages, and integrate our logistics services into your workflow.

Base URLs​

Fuuffy provides separate environments for testing and production:

EnvironmentBase URL
Testinghttps://testing-api-gateway.fuuffy.com/v1
Productionhttps://api-gateway.fuuffy.com/v1

API Features​

  • OAuth 2.0 Authentication - Secure token-based authentication
  • Order Management - Create, update, and cancel orders
  • Real-time Tracking - Track your orders in real-time
  • Webhook Notifications - Receive updates about order status changes (Coming Soon)
  • RESTful Design - Standard HTTP methods and status codes

Quick Start​

1. Get API Credentials​

To use the Fuuffy API, you'll need:

  • Fuuffy Account - A validate Fuuffy account with monthly payment plan enabled
  • Client ID - Your application identifier
  • Client Secret - Your application secret key

Contact our support team at support@fuuffy.com to obtain your credentials.

2. Authenticate​

Use OAuth 2.0 to obtain an access token.

Endpoint: https://testing-api-gateway.fuuffy.com/v1/auth/token

Production Example:

curl -X POST https://api-gateway.fuuffy.com/v1/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Testing Example:

curl -X POST https://testing-api-gateway.fuuffy.com/v1/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Response:

{
  "data": {
    "access_token": "sk-418e41a74ca2e7d941fa4456d73dbed7",
    "token_type": "Bearer",
    "expires_in": 3600
  }
}
info

All Fuuffy API responses are wrapped in a data object. See Standard Response Format for details.

3. Make Your First API Call​

Create a order using your access token.

Endpoint: https://testing-api-gateway.fuuffy.com/v1/orders

Testing Example:

curl -X POST https://testing-api-gateway.fuuffy.com/v1/orders \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": {
      "name": "John Doe",
      "phone": "+1234567890",
      "address": "123 Main St, City, Country"
    },
    "recipient": {
      "name": "Jane Smith",
      "phone": "+0987654321",
      "address": "456 Oak Ave, City, Country"
    },
    "package": {
      "weight": 2.5,
      "dimensions": {
        "length": 30,
        "width": 20,
        "height": 15
      }
    }
  }'

Response:

{
  "data": {
    "id": "shp_1234567890",
    "status": "pending",
    "tracking_number": "FUF123456789",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Next Steps​

Support​

Need help? Contact us: