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

Terapi Integrations API

Manage available integration configurations

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

Tagged areas include Integrations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

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

Requests are made against 2 base URLs: https://api.terapi.dev, http://localhost:3003.

4 operations 2 paths 4 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Servers
https://api.terapi.dev
http://localhost:3003
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Terapi Integrations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SecretKeyAuth). By default, every request must be authenticated.

  • SecretKeyAuth — Secret key from Terapi environment settings. Passed as 'Bearer {secretkey}'

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.

Integrations 4

Manage available integration configurations

GET
/integration
List Integrations
listIntegrations → 200401
POST
/integration
Create Integration
createIntegration body → 200400401
GET
/integration/{provider_config_key}
Get Integration
getIntegration 1 param → 200401404
DELETE
/integration/{provider_config_key}
Delete Integration
deleteIntegration 1 param → 204401404

Schemas 4

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

IntegrationListResponse
object
1 property
Integration
object
An integration configuration for a third-party provider
5 properties
CreateIntegrationRequest
object
5 properties 2 required
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terapi-integrations-api-openapi.yml Raw ↑

Other APIs Terapi publishes across the network.

Terapi Actions API
Terapi Authentication API
Terapi Connections API
Terapi Sync API