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 ping API

The ping API from Roadsync — 1 operation(s) for ping.

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

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

This API exposes 1 operation across 1 path, and defines 3 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}.

1 operations 1 paths 3 schemas 1 GET

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 ping 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 1

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

ping 1
GET
/ping
Ping the payment-api service. Will also validate the api key present on the request
ping_get → 200400

Schemas 3

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

Errors
array
A list of errors that occurred during payment processing
PaymentResponse
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-ping-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
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