Crear Agente

POSThttps://{environment}.metrocuadrado.com/rest-api/agents/

Ambientes Disponibles

Ambiente	URL Base
Desarrollo	https://ptec-core-dev.metrocuadrado.com/rest-api/agents/
Producción	https://www.metrocuadrado.com/rest-api/agents/

Parámetros

Headers

Header	Valor	Requerido	Descripción
Content-Type	application/json	Sí	Tipo de contenido
x-api-key	string	Sí	API key de autenticación
token	string	Sí	Token JWT de acceso

Body

Campo	Tipo	Requerido	Descripción	Ejemplo
email	string	Sí	Correo electrónico del agente	"user@domain.com"
name	string	Sí	Nombre del agente	"Pablo"
lastname	string	Sí	Apellido del agente	"Gomez"
documentNumber	integer	Sí	Número de documento	1234567890
city	integer	Sí	ID de la ciudad	1
branchOffice	integer	Sí	ID de la sucursal	54150
personContactPhoneList	array	Opcional	Lista de teléfonos fijos	Ver ejemplo completo
personContactMobileList	array	Opcional	Lista de teléfonos móviles	Ver ejemplo completo
integratorId	integer	Sí	ID del integrador	2
responseUrl	string	Opcional	URL de callback para la respuesta	"https://callback.com"

Ejemplos

Request

curl -X POST 'https://ptec-core-dev.metrocuadrado.com/rest-api/agents/' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'token: tu-jwt-token' \
  -d '{
    "email": "usuario99@ejemplo.com",
    "name": "Lucía",
    "lastname": "Ramírez",
    "documentNumber": "9876543210",
    "city": 3,
    "branchOffice": 78234,
    "personContactPhoneList": [
      {
        "value": "4445555",
        "extension": "2211"
      }
    ],
    "personContactMobileList": [
      {
        "value": "3209876543",
        "contactWithWathsapp": "S"
      }
    ],
    "responseUrl": "https://example.com/api/callback"
  }'

201 Created

{
  "data": {
    "transactionId": "874e70d0-08f5-425a-a2ba-a0f67f63aad2",
    "response: ": "Transacción de creación agente recibida"
  }
}

400 Bad Request

{
  "error": "Faltan parámetros obligatorios: email, name, lastname"
}

401 Unauthorized

{
  "error": "Token de autorización inválido o expirado"
}

409 Conflict

{
  "error": "El usuario no tiene cupos suficiente para crear el agente"
}

Notas Importantes

- Requiere un token JWT válido (generar en el endpoint de autenticación)

- La API Key debe corresponder al ambiente seleccionado

- Todos los campos marcados como requeridos deben enviarse

• Los teléfonos se envían como arrays de objetos

Cómo Probar

Para probar este endpoint, sigue estos pasos:

1. Genera un token JWT usando el endpoint de autenticación
2. Asegúrate de usar la API Key correcta según el ambiente
3. Incluye el token en el header token
4. Prepara el body JSON con los datos del agente
5. Realiza la petición POST al endpoint correspondiente

Códigos de Respuesta

Código	Descripción
201	Agente creado exitosamente
400	Parámetros inválidos o faltantes
401	Token inválido o expirado
403	API Key inválida o faltante
409	El usuario no tiene cupos suficiente

Probar Endpoint

API Tester

Prueba los endpoints de forma interactiva

Token Requerido

Este endpoint requiere autenticación. Configura un token JWT válido usando el botón de token en la parte superior de la página.

Ambiente: DesarrolloProducción

Request Body (JSON):

{}