Partner Connections API

The Partner Connections API allows you to manage partner connections in your WeComplete application.

API Documentation

POST /api/partnerConnections/create

Create a new partner connection.

Example Request:

POST /api/partnerConnections/create
Headers:
  Content-Type: application/json
  x-wecomplete-api: YOUR_API_KEY
Body:
  {
    "userId": "user_01234567",
    "connectionCode": "ABCD1234"
  }

Example Response:

{
  "status": "success",
  "data": {
    "connectionId": "connection_01234567"
  }
}

GET /api/partnerConnections/get/:userId

Retrieve the partner connection for a specific user.

Example Request:

GET /api/partnerConnections/get/:userId
Headers:
  Content-Type: application/json
  x-wecomplete-api: YOUR_API_KEY

Example Response:

{
  "status": "success",
  "data": {
    "userId": "user_01234567",
    "partnerId": "user_89012345",
    "connectionCode": "ABCD1234"
  }
}

POST /api/partnerConnections/link

Link two users as partners.

Example Request:

POST /api/partnerConnections/link
Headers:
  Content-Type: application/json
  x-wecomplete-api: YOUR_API_KEY
Body:
  {
    "userId": "user_89012345",
    "connectionCode": "ABCD1234"
  }

Example Response:

{
  "status": "success",
  "data": {
    "partnerId": "user_01234567"
  }
}

POST /api/partnerConnections/unlink

Unlink two partnered users.

Example Request:

POST /api/partnerConnections/unlink
Headers:
  Content-Type: application/json
  x-wecomplete-api: YOUR_API_KEY
Body:
  {
    "userId": "user_01234567"
  }

Example Response:

{
  "status": "success",
  "data": {
    "success": true
  }
}

Live API Testing

Test POST /api/partnerConnections/create

Test GET /api/partnerConnections/get/:userId

Test POST /api/partnerConnections/link

Test POST /api/partnerConnections/unlink