Flott Operator API Documentation

Version 2.0

Introduction

The Flott Operator API v2.0 provides a comprehensive interface for managing taxi operations. This documentation will guide you through the available endpoints and features.

All API requests should be made to:

https://api.goflott.com

Authentication

All API requests require authentication using an API token. To obtain your API token:

  1. Contact your Flott representative to request API access
  2. Include the API token in the Authorization header of every request:
Authorization: YOUR_API_TOKEN

Keep your API token secure and do not share it with unauthorized parties. If you believe your token has been compromised, contact Flott support immediately.

API Reference

For detailed API documentation, please refer to:

API Endpoints Reference - Detailed documentation of all available API endpoints and methods

API Objects Reference - Comprehensive documentation of all API objects and their fields

Troubleshooting

If you are facing troubles with Operator API, please follow these steps:

  1. Ensure first that you compose requests correctly
  2. Check error response messages and study how to fix requests according to this documentation

If nothing helps, please contact [email protected] and provide as many details about your problem as you can:

  • Exact timestamp
  • URL including protocol, hostname, port, and all parameters
  • HTTP method
  • Request payload (body) for all non-GET HTTP methods
  • Request headers: used API token (last part of it)
  • Timestamp when the response was received
  • Response HTTP code
  • Response body
  • Response headers

HTTP Methods 2.0

Get Tariff

GET/dispatch/v2/tariff

Searching for tariffs at some location filtered by the provided parameters. In each request, there should be at least an origin parameter.

Prepare an Order

POST/dispatch/v2/order/prepare

Prepares data for a new order. Preparation request is needed to fix estimation price.

Update Prepared Data

PUT/dispatch/v2/order/prepare/{ORDER_ID}

Updates data prepared in Prepare an order V2 for a new order.

Confirm an Order

POST/dispatch/v2/order/confirm/{ORDER_ID}

Confirm order creation. The order will be visible in the Dispatch panel.

WebSocket

Order Updates Notifications

WS/dispatch/v1/notification/{AUTH_TOKEN}

WebSocket to listen for order update notifications. Connection limit is 100 connections/hour.