Uber Developers

Uber

Developers

Sandbox Experience

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

Rental platform supports integration experience with sandbox env.

There are prod and testing vehicles in Uber’s backend system. Only testing vehicles are enabled to integrate with rental platform’s sandbox API. Testing vehicles will NOT interact with prod env, which means all operations for testing vehicles will not affect prod data through Uber public API.

However, there is inconsistent testing vehicles experience between various Uber internal services, so not all APIs will support sandbox experience. Also for some APIs without interaction with vehicles data, there is NO difference between sandbox and prod env, such as get driver’s info etc.

¶ Sandbox endpoint

Uber’s sandbox endpoint https://sandbox-api.uber.com.

Example(Get Vehicle API):

Get token:

curl -X POST "https://auth.uber.com/oauth/v2/token" \
 -F 'client_id=<CLIENT_ID>' \
 -F 'client_secret=<CLIENT_SECRECT>' \
 -F "grant_type=client_credentials" \
 -F "scope=vehicle_suppliers.vehicles.read"

Call Get vehicle sandbox api:

curl GET "https://sandbox-api.uber.com/v1/vehicle-suppliers/vehicles/:vehicle_id" \
 -H "Authorization: Bearer <TOKEN>"

More details: Sandbox API

¶ Fully-supported sandbox endpoints with testing vehicles

The following endpoints are supported in the sandbox environment with testing vehicles

¶ Vehicle Management API

¶ [API] Create Vehicle [API reference]

¶ [API] Delete Vehicle [API reference]

¶ [API] Transfer Vehicle [API reference]

¶ [API] Assign Vehicle [API reference]

¶ [API] Unassign Vehicle [API reference]

¶ Partially-supported sandbox endpoints with testing vehicles

The following endpoints are partially supported in the sandbox environment with testing vehicles

¶ Vehicle Legacy API

The upload document api will be partially supported for sandbox API.

By passing document_type: "TEST_REQUIRED_DOCUMENT" in request body, the request will succeed, otherwise it will failed

¶ [API] Upload Document [API reference]

¶ Vehicle Management API

The following APIs will be partially supported for sandbox API.

By passing _all_ fields in query params, the request will fail due to incompatible testing vehicles in different internal services.
Without passing fields in query params, the request will succeed

¶ [API] Get Vehicle [API reference]

¶ [API] Get Vehicle By Owner [API reference]

¶ [API] Search Vehicle [API reference]

¶ Partially-supported sandbox endpoints with testing data

The following endpoints are partially supported in the sandbox environment with testing data or response

¶ Supplier Performance Data API

¶ [API] Supplier Performance Data [API reference]

The following is the expected response

{
  "reports": [
    {
      "columnHeader": {
        "dimensionHeaderEntries": [
          {
            "name": "VIN_Test",
            "type": "DIMENSION_TYPE_STRING"
          }
        ],
        "metricHeaderEntries": [
          {
            "name": "TotalTripsTest",
            "type": "METRIC_TYPE_INT32"
          }
        ]
      },
      "data": {
        "timeRangeData": [
          {
            "rows": [
              {
                "dimensionValues": [
                  "VIN_ABC"
                ],
                "metricValues": [
                  "3.14"
                ],
                "dimensionName": "UUID",
                "dimensionId": "8LXQdrVZDtraWLeNz6_tqiRPXV2rAMvy_RyJXh3kfQc6MDFeuQ9-kqiuYaqXEHlEADboGFsahV2nkjA40K8GWwflyhzuTGW-R6AKOGBrNvYK1fcV-DnsuvuKgY5nLI7RCQ=="
              }
            ]
          }
        ]
      },
      "paginationResult": {}
    }
  ]
}

¶ Unsupported sandbox endpoints with testing vehicles

The following endpoints are not supported in the sandbox environment. It will fail due to incompatible testing vehicles in different internal services.

¶ Vehicle Management API

¶ [API] Update Vehicle [API reference]

¶ Other API

Same experience as prod API. It will do operation with prod data.

Uber

Developers