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

Ada subpackage_platformIntegrations API

The subpackage_platformIntegrations API from Ada — 4 operation(s) for subpackage_platformintegrations.

Ada subpackage_platformIntegrations API is one of 13 APIs that Ada publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 5 base URLs: https://example.ada.support, https://example.att.ada.support, https://example.maple.ada.support, https://example.ficanex.ada.support, https://example.eu.ada.support.

5 operations 4 paths 24 schemas 2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ada.cx
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ada subpackage_platformIntegrations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 5

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

subpackage_platformIntegrations 5
GET
/v2/platform-integrations/
List integrations
get-platform-integrations 3 params → 200401404429500
POST
/v2/platform-integrations/
Create an integration
create-platform-integration 1 param body → 200400401403429500
PATCH
/v2/platform-integrations/{id}
Update an integration
update-single-platform-integration 2 params body → 200400401403429500
GET
/v2/platform-integrations/{id}/installations/self
Get an installation
get-platform-integration-installation-self 2 params → 200400401403404429500
PATCH
/v2/platform-integrations/{platform_integration_id}/installations/{installation_id}
Update installation status
update-platform-integration-installation 3 params body → 200400401403404429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Platform Integrations_createPlatformIntegration_Response_200 (18 properties), PlatformIntegration (17 properties), PlatformIntegrationUpdateRequest (13 properties), PlatformIntegrationCreateRequest (13 properties). Each schema is shown below with its type and property counts.

PlatformIntegrationInstallationUpdateRequest
object
1 property
PaginationMetadata
object
1 property
PlatformIntegrationTagsItems
string
IntegrationCommonFieldsErrorCodes
object
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed
Platform Integrations_createPlatformIntegration_Response_200
object
18 properties 12 required
PlatformIntegrationCreateRequestTagsItems
string
IntegrationIdentifierField
string
JMESPath describing which of the fields in configurationfields is the best human-friendly field to use to identify a specific installation (e.g., account name)
PlatformIntegrationCreateRequestConfigurationFields
object
A json-schema describing the settings fields that a user should be presented with when installing the integration
PlatformIntegration
object
17 properties 12 required
PlatformIntegrationInstallationUpdateRequestStatus
string
The new status of the installation
PlatformIntegrationConfigurationFields
object
A json-schema describing the settings fields that a user should be presented with when installing the integration
PlatformIntegrationUpdateRequest
object
13 properties
PlatformIntegrationCreateRequest
object
13 properties 10 required
PlatformIntegrationCreateRequestErrorCodes
object
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed
PlatformIntegrationErrorCodes
object
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed
PlatformIntegrationInstallationConfiguration
object
The configuration settings for the integration
IntegrationCallToAction
stringnull
The call to action text
Platform Integrations_getPlatformIntegrations_Response_200
object
2 properties
ErrorsErrorsItems
object
3 properties 2 required
IntegrationIconUrl
stringnull
The URL of the icon that should be displayed with your integration
IntegrationCommonFieldsConfigurationFields
object
A json-schema describing the settings fields that a user should be presented with when installing the integration
Errors
object
1 property 1 required
IntegrationCommonFieldsTagsItems
string
PlatformIntegrationInstallation
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ada-subpackage-platformintegrations-api-openapi.yml Raw ↑

Other APIs Ada publishes across the network.

Ada End Users API
Ada Conversations API
Ada Integrations API
Ada subpackage_channels API
Ada subpackage_conversations API
Ada subpackage_deleteChatterData API
Ada subpackage_endUsers API
Ada subpackage_knowledge.subpackage_knowledge/articles API
Ada subpackage_knowledge.subpackage_knowledge/sources API
Ada subpackage_knowledge.subpackage_knowledge/tags API
Ada subpackage_messages API
Ada subpackage_webhookManagement API