Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync authenticated API

Authenticated operations not otherwise functionally categorized

Roadsync authenticated API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include authenticated. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

2 operations 1 paths 5 schemas 1 GET1 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync authenticated API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 OPTIONS. Each is listed below with its method, path, parameters, and response codes.

authenticated 2

Authenticated operations not otherwise functionally categorized

GET
/logout
Log user out and invalidate session token
logout_get → 200401403404429500default
OPTIONS
/logout
logout_options → 200401403404429500default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Problem (5 properties), CodeMessage (2 properties). Each schema is shown below with its type and property counts.

CodeMessage
object
A generic error object generally used for 500 responses
2 properties 2 required
Problem
object
5 properties
CodeEnum
string
LogoutResponse
object
Message
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-authenticated-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API
Roadsync ping API