Ryder Developer Portal
Sign Up

Getting Started with FMS Fleet APIs

The FMS Fleet API allows Ryder lease customers to access critical fleet data associated with their FMS fleet account. This documentation provides detailed information about the API endpoints, their usage, and example use cases.  

API Overview

Fleet API

  • Access Ryder fleet details, including vehicle information, maintenance history, specifications, and more. This API is ideal for managing fleet data, tracking service history, and optimizing maintenance operations.

Locations API

  • Retrieve location information, including address, services offered, business hours, and contact details. Use this API to integrate Ryder’s location data and enhance the visibility of service offerings for fleet management.

Prerequisites

  • You have a Ryder Developer Portal account. Sign up here to create a free account and gain access to all developer documentation.

  • You have cURL, Postman, or a similar tool installed to make API calls

  • You are a Ryder customer with an assigned lessee number

Authentication

The API uses an API key for authentication. The key should be included in the request headers as follows: 

GET /vehicles HTTPS/1.1 
Host: api.ryder.com/fms 
Ocp-Apim-Subscription-Key: your_api_key_here 

Step 1: Create an Application

  1. Log in to the Ryder API Developer Portal

  2. Navigate to My Account> My Apps

  3. Create an application

    • App Name: Insert your company and app name

    • Oauth Redirect URL: Leave Blank

    • API Product: Select "FMS Fleet API"

  4. On first login, you will be required to review and accept the Developer Terms of Service.

  5. Ryder will review the request and grant approval. This may take 1-2 business days.

Step 2: Access your API Key

1. Navigate to My Account> My Apps

2. Scroll to the Applications List.

3. Copy the API Key.

Step 3: Request data

  1. For this example, we'll use the Vehicles API

  2. Include the API Key in the Authorization header of your API call:

GET /vehicles HTTPS/1.1 
Host: api.ryder.com/fms 
Ocp-Apim-Subscription-Key: your_api_key_here 

If the request is successful, the API will return a confirmation message.

Endpoint Overview

For the complete Open API Specification and examples, visit the Fleet API product page.

  • /vehicles: Retrieves a list of vehicles accessible to the customer, including details like vehicleNumber, VIN, and domicileLocation. This endpoint supports filtering by attributes such as VIN and licensePlate to help locate specific vehicles.

  • /vehicles/{vehicleNumber}: Provides comprehensive details for a single vehicle based on its vehicleNumber, including make, model, year, and lease information. Use this endpoint to get full insights on individual vehicle attributes and specifications.

  • /serviceHistory: Returns historical maintenance and repair records for vehicles in the fleet, with options to filter by vehicleNumber and date range. This is useful for tracking service events and planning preventive maintenance.

  • /locations: Retrieves a list of Ryder service locations, complete with details like location code, name, and available services. Filter options allow searching by attributes to find specific locations for fuel, maintenance, or rest.

  • /locations/{locationNumber}: Provides in-depth information for a specific location, including address, services, and amenities. Use this endpoint to access location-specific data, such as business hours and contact information.

Use Cases

Use Case 1: Retrieve All Vehicles for a Customer 

A customer wants to retrieve a list of all vehicles they have access to. They can use the ‘GET /vehicles’ endpoint with their customer number as a query parameter. 

GET /vehicles?customerNumber=23456 HTTPS/1.1 
Host: api.ryder.com/fms 
Ocp-Apim-Subscription-Key: your_api_key_here 

Use Case 2: Retrieve a Specific Vehicle by VIN 

A customer needs details about a specific vehicle identified by its VIN. They can use the ‘GET /vehicles’ endpoint with the VIN as a query parameter. 

GET /vehicles?vin=3ALACXFC3LDLZ3143 HTTPS/1.1 
Host: api.ryder.com/fms 
Ocp-Apim-Subscription-Key: your_api_key_here 
Use Case 4: Retrieve a Vehicle by Vehicle Number 

A customer needs detailed information about a specific vehicle. They can use the ‘GET /vehicles/{vehicleNumber}’ endpoint with the vehicle number. 

GET /vehicles/277686 HTTPS/1.1 
Host: api.ryder.com/fms 
Ocp-Apim-Subscription-Key: your_api_key_here