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

APIs.io Engineering Platform Magic Connectors API

The Magic Connectors API from APIs.io Engineering Platform — 2 operation(s) for magic connectors.

This API exposes 4 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

4 operations 2 paths 14 schemas 2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Magic Connectors API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

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

Magic Connectors 4
GET
/accounts/{account_id}/magic/connectors
APIs.io Engineering Platform List Connectors
mconn-connector-list 1 param → 200400401403500
GET
/accounts/{account_id}/magic/connectors/{connector_id}
APIs.io Engineering Platform Fetch Connector
mconn-connector-fetch 2 params → 200400401403500
PATCH
/accounts/{account_id}/magic/connectors/{connector_id}
APIs.io Engineering Platform Update Connector
mconn-connector-update 2 params body → 200400401403500
PUT
/accounts/{account_id}/magic/connectors/{connector_id}
APIs.io Engineering Platform Replace Connector
mconn-connector-replace 2 params body → 200400401403500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are mconn_customer_connector (10 properties), mconn_customer_connector_fields (5 properties), mconn_response (2 properties), mconn_customer_device (2 properties). Each schema is shown below with its type and property counts.

mconn_response
object
2 properties 4 required
mconn_customer_connector_fields
object
5 properties
mconn_customer_device
object
2 properties 1 required
mconn_customer_connector
object
10 properties 7 required
mconn_bad_response
mconn_good_response
mconn_customer_connector_fetch_response
mconn_customer_connector_update_response
mconn_account_id
string
Account identifier
mconn_customer_connector_list_response
mconn_none
object
mconn_uuid
string
mconn_customer_connector_update_request
mconn_coded_message
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-magic-connectors-api-openapi.yml Raw ↑