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

Kanmon Sandbox Utilities API

The Sandbox Utilities API from Kanmon — 2 operation(s) for sandbox utilities.

Kanmon Sandbox Utilities API is one of 14 APIs that Kanmon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 4 base URLs: https://api.kanmon.com, https://api.kanmon.dev, http://localhost:3333, https://workflow.concar.dev.

2 operations 2 paths 6 schemas 1 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api.kanmon.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kanmon Sandbox Utilities API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

Paths & Operations 2

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

Sandbox Utilities 2
POST
/api/platform/v2/sandbox/businesses/{id}/reset
Reset a business in sandbox
sandboxResetBusiness 2 params → 200400403429500
DELETE
/api/platform/v2/sandbox/businesses/{id}/delete
Delete a business in sandbox
sandboxDeleteBusiness 2 params → 204400403429500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Business (12 properties), Address (6 properties), BadRequestException (3 properties), ForbiddenException (3 properties). Each schema is shown below with its type and property counts.

Business
object
12 properties 8 required
InternalServerErrorException
object
3 properties 3 required
Address
object
6 properties 5 required
TooManyRequestsException
object
3 properties 3 required
ForbiddenException
object
3 properties 3 required
BadRequestException
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kanmon-sandbox-utilities-api-openapi.yml Raw ↑

Other APIs Kanmon publishes across the network.

Kanmon Bank Accounts API
Kanmon Businesses API
Kanmon Connect Tokens API
Kanmon Documents API
Kanmon Draw Requests API
Kanmon Embedded Sessions API
Kanmon Integrated MCA API
Kanmon Invoices API
Kanmon Issued Products API
Kanmon Offers API
Kanmon Payments API
Kanmon Prequalifications API