How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Aptean Consumers API

The Consumers API from Aptean — 2 operation(s) for consumers.

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

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

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

Requests are made against a single base URL, https://stg.integration-graph.apteansharedservices.com.

4 operations 2 paths 11 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://stg.integration-graph.apteansharedservices.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Aptean Consumers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 4

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

Consumers 4
GET
/v1/consumers
Gets all consumers tenants for the producer tenant.
4 params → 200400500401
POST
/v1/consumers
Create new consumer subscription for specific event type.
4 params body → 202400500401
GET
/v1/consumers/{id}
Get a speific consumer subscription detail by ID.
GetConsumerById 4 params → 200400500401404
DELETE
/v1/consumers/{id}
Deletes a consumer.
5 params → 202400500401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Aptean.ATG.IntegrationPlatform.Api.Resources.Consumer (12 properties), Aptean.ATG.IntegrationPlatform.Api.Resources.SubscribedEvent (6 properties), Microsoft.AspNetCore.Mvc.ProblemDetails (5 properties), Aptean.ATG.IntegrationPlatform.Api.Resources.Requests.NewConsumerRequest (5 properties). Each schema is shown below with its type and property counts.

Aptean.ATG.IntegrationPlatform.Api.Resources.Responses.AipWarningResponse
object
Warning AIP response.
1 property
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Aptean.ATG.IntegrationPlatform.Api.Resources.GenericResponses.DeleteResponse
object
Resource to describe the delete action.
2 properties
Aptean.ATG.IntegrationPlatform.Api.Resources.Responses.AipErrorResponse
object
Error AIP response.
2 properties
Aptean.ATG.IntegrationPlatform.Api.Resources.Responses.AipSuccessResponse_1_Aptean.ATG.IntegrationPlatform.Api.Resources.Consumer
object
Success typed AIP response. Type of the item.
2 properties
Aptean.ATG.IntegrationPlatform.Api.Resources.GenericResponses.ResponseResult
string
Describes the global result.
Aptean.ATG.IntegrationPlatform.Api.Resources.SubscribedEvent
object
Resource that represents subscribed event.
6 properties 4 required
Aptean.ATG.IntegrationPlatform.Api.Resources.Requests.NewConsumerRequest
object
New consumer request.
5 properties 2 required
Aptean.ATG.IntegrationPlatform.Api.Resources.Base.ProvisioningStatus
string
Indicates the status of provisioning.
Aptean.ATG.IntegrationPlatform.Api.Resources.Consumer
object
Resource that represents a consumer.
12 properties 1 required
Aptean.ATG.IntegrationPlatform.Api.Resources.Responses.AipSuccessResponse_1_Aptean.ATG.IntegrationPlatform.Api.Resources.GenericResponses.DeleteResponse
object
Success typed AIP response. Type of the item.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aptean-consumers-api-openapi.yml Raw ↑

Other APIs Aptean publishes across the network.

Aptean EventDefinitions API
Aptean Events API
Aptean Producers API
Aptean PublicKeys API
Where this information came from

This is an independent, third-party profile of Aptean Consumers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.