Skip to main content
POST
Adherir un usuario a un producto

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Cuerpo

application/json

Body de POST /adhesions y POST /adhesions/cancel. Solo acepta externalClientId, productId, externalProductId y companyCode: cualquier otro campo devuelve 400 con el campo en details[].field. Debes enviar uno de productId o externalProductId (no ambos, no ninguno).

externalClientId
string
requerido

Tu identificador del usuario final: el mismo del enrolamiento. Solo letras, dígitos, _ y -, hasta 100 caracteres.

Maximum string length: 100
Pattern: ^[\w-]{1,100}$
productId
string

ID del producto en Tapi, formato prd_<número>. Excluyente con externalProductId.

Pattern: ^prd_\d+$
externalProductId
string

Tu identificador del producto. Excluyente con productId. No admite los caracteres ', ", \, ; (400).

companyCode
string

Opcional. Solo si tu cliente tiene varias companies; si no, se resuelve desde el token.

Respuesta

La adhesión ya existía (activa con el medio actual, reactivada o repuntada al medio actual).

data
object

Adhesión del usuario a un producto. No incluye el medio de pago.

requestId
string