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:

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

Every AS2 action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/as2/latest/actions/{actionSlug}

You need a MindCloud API Key and a AS2 connection. Then call an action such as Get File Content:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/as2/latest/actions/get-file-content" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected AS2 account that should run the action. MindCloud stores and refreshes the AS2 credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

AS2 actions

All 5 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.

Quickstart

Authentication

AS2 actions

Related apps