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

Kontomatik Command API

Background import commands and consent management

Kontomatik Command API is one of 16 APIs that Kontomatik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Command. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.kontomatik.com/v1, https://test.api.kontomatik.com/v1.

4 operations 4 paths 8 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Servers
https://api.kontomatik.com/v1
https://test.api.kontomatik.com/v1
Authentication
API Key
License
Commercial — see https://kontomatik.com
Resource Areas
1

Authentication & Security 1

Kontomatik Command API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key issued by Kontomatik; requests must originate from a whitelisted server.

Paths & Operations 4

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

Command 4

Background import commands and consent management

POST
/command/default-import.xml
Start Default Data Import
startDefaultImport body → 200
GET
/command/{id}.xml
Get Command Status
getCommandById 1 param → 200
POST
/command/reuse-multiple-access.xml
Reuse Multiple Access Token
reuseMultipleAccess body → 200
POST
/command/delete-multiple-access.xml
Delete Multiple Access Consent
deleteMultipleAccess body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Transaction (7 properties), CommandResult (6 properties), Account (5 properties), DefaultImportRequest (4 properties). Each schema is shown below with its type and property counts.

Transaction
object
7 properties
CommandResult
object
6 properties
ReuseMultipleAccessRequest
object
2 properties 1 required
DefaultImportRequest
object
4 properties 2 required
DeleteMultipleAccessRequest
object
1 property 1 required
Owner
object
4 properties
CommandAccepted
object
2 properties
Account
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kontomatik-command-api-openapi.yml Raw ↑

Other APIs Kontomatik publishes across the network.

Kontomatik Aggregation API
Kontomatik Catalog API
Kontomatik Confirmations API
Kontomatik Features API
Kontomatik Income API
Kontomatik Labeling API
Kontomatik Mock API
Kontomatik Owner API
Kontomatik Profile API
Kontomatik Reports API
Kontomatik Score API
Kontomatik SignIn API