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

Cargomatic Authorization API

Endpoints dealing with authenticating to the API

Cargomatic Authorization API is one of 5 APIs that Cargomatic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authorization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api-acceptance.cargomatic.com.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.cargomatic.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cargomatic Authorization API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 1

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

Authorization 1

Endpoints dealing with authenticating to the API

POST
/auth
Retrieves an access token.
auth body → 200400500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AuthResponse (2 properties), AuthRequestBody (2 properties), BadRequestResponse (1 property), InternalServerErrorResponse (1 property). Each schema is shown below with its type and property counts.

InternalServerErrorResponse
object
1 property
AuthRequestBody
object
2 properties 2 required
AuthResponse
object
2 properties
BadRequestResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cargomatic-authorization-api-openapi.yml Raw ↑

Other APIs Cargomatic publishes across the network.

Cargomatic Carrier API
Cargomatic Document API
Cargomatic Shipper API
Cargomatic Stops API