Trading Partners
Manage the trading partners with whom you exchange AS2 messages.
POST
/api/v1/partners
Get the list of trading partners configured for your stations.
Request body (optional)
| Field | Type | Description |
|---|---|---|
| station | integer | Filter by station |
Ejemplo Python
response = requests.post(
f"{BASE_URL}/partners",
headers=headers,
json={"station": 54}
)
POST
/api/v1/partners/detail
Return extended details for a specific partner.
| Field | Type | Required |
|---|---|---|
| id | integer | Yes |
POST
/api/v1/partners/create
Create a new trading partner to exchange AS2 messages.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| station | integer | Yes | Your station ID |
| as2_id | string | Yes | Partner AS2 identifier |
| name | string | Yes | Partner name |
| string | Yes | Contact email | |
| endpoint_url | string | Partner AS2 endpoint | |
| mdn | integer | MDN type | |
| certificate_id | integer | Public certificate associated with the partner | |
| encryption | integer | Preferred encryption algorithm | |
| signature | integer | Preferred signature algorithm | |
| auth | boolean | Enable outbound authentication | |
| auth_user | string | HTTP authentication user | |
| auth_password | string | HTTP authentication password | |
| firewall | boolean | Enable additional firewall rules |
Ejemplo Python
response = requests.post(
f"{BASE_URL}/partners/create",
headers=headers,
json={
"station": 62,
"as2_id": "AS2:CLIENTE_001",
"name": "Primary Customer",
"endpoint_url": "https://cliente.com/as2",
"email": "as2@cliente.com",
"certificate_id": 129
}
)Response
{
"status": "success",
"msg": "Partner created",
"data": {
"id": 107,
"partner_id": 107,
"station_id": 62,
"name": "Primary Customer",
"as2_id": "AS2:CLIENTE_001",
"url": "https://cliente.com/as2"
}
}
POST
Partner trust lifecycle
Partner creation is only the first step. In product, each partner can also carry a governed trust lifecycle with current certificate, next certificate, rollover window, TSA evidence, and event timeline.
| Operator surface | What it solves |
|---|---|
Trust Lifecycle | Define current and next certificates and keep rollover dates coherent. |
CemScheduleRollover | Persist the approved rollover window before activation. |
CemActivate | Promote the next certificate to current with auditable evidence. |
CemRetire | Retire the old trust material after the overlap window closes. |
CemEvents | Read the partner timeline as operational evidence during pilot and release review. |