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

Adopets system-auth API

Connect/disconnect an external system user and obtain a session token

Adopets system-auth API is one of 3 APIs that Adopets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include system-auth. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 2 base URLs: https://service.api.dev.adopets.app, https://service.api.adopets.app.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://service.api.dev.adopets.app
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

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

  • apiKeyAuth — Organization API key issued by Adopets, sent on every request.
  • sessionBearer — Per-session token (data.authorization) returned by system-auth/connect.

Paths & Operations 2

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

system-auth 2

Connect/disconnect an external system user and obtain a session token

POST
/organization/external/system-auth/connect
Connect external system user
connectExternalSystemUser 1 param body → 200default
POST
/organization/external/system-auth/disconnect
Disconnect external system user
disconnectExternalSystemUser 1 param body → 200default

Schemas 4

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

ExternalSystemUser
object
4 properties 1 required
EnvelopeError
Error variant of the standard envelope (prefix 4xx/5xx, non-OK message).
Envelope
object
Standard Adopets response envelope.
5 properties
EnvelopeAuth

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adopets-system-auth-api-openapi.yml Raw ↑

Other APIs Adopets publishes across the network.

Adopets payment-request API
Adopets payment-transaction API