Sign inGet started
Docs
Get started

AS2 API Documentation

This is the complete API documentation for connecting to the AS2 API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet AS2: Transfer business documents securely using the AS2 protocol. Keep reading to get started.

Quickstart

Before you run your first AS2 request, you need three things:

  1. A MindCloud account — sign in or create an account at MindCloud.
  2. A MindCloud API Key — create one in API Keys. Keep it on your server.
  3. At least one AS2 connection — create or choose one in Connections. Note its connectionId.

Every AS2 action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/as2/actions/{actionSlug}/run

You need a MindCloud API Key and a AS2 connection. Then call an action such as List Files:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/as2/actions/list-files/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your AS2 account. See AS2 API Authentication for the full flow and how to get your connection credentials.

AS2 actions

All 6 published actions for this AS2 version. Each page documents the endpoint, arguments, and response controls.

More Commerce apps on the Universal API, behind the same REST shape. Or browse all apps.

StripeShopifySquareXeroThinkificWhopGumroadEcwid