SDKs

Typed clients, generated from the spec

Each client is regenerated and published whenever the API's OpenAPI document changes, so it never lags the API.

TypeScript

Published to GitHub Packages. Add the registry for the scope, then install:

# .npmrc
@fleetfully:registry=https://npm.pkg.github.com

npm install @fleetfully/api-client

import { client, createOrder, getTracking } from "@fleetfully/api-client";

client.setConfig({ baseUrl: "https://<your app host>/api/ext/v2", headers: { Authorization: `Bearer ${process.env.API_KEY}` } });
const { data } = await createOrder({ body: { customerCode: "SANDBOX", delivery: { address: { text: "100 Main St, Springfield, IL" } } }, headers: { "Idempotency-Key": crypto.randomUUID() } });

Python

Each release attaches a wheel to the repository's SDK releases:

pip install fleetfully-api-client-<version>-py3-none-any.whl

from fleetfully_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://<your app host>/api/ext/v2", token="ffk_test_…")

Postman and OpenAPI

Download the Postman collection (set baseUrl and a test key in apiKey), or generate your own client from the OpenAPI 3.1 document.