Gestionar recursos

Esta guía muestra las operaciones de gestión más comunes. Antes de comenzar, obtenga un token según Autenticación y defina las variables:

API_BASE='https://api.exemplo.com:33070'
ACCESS_TOKEN='<access_token>'

El contrato de todos los endpoints está en la Especificación OpenAPI y las convenciones en Recursos de gestión.

Liste las instancias

curl -s "$API_BASE/stcpcore/v2/instances" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Accept: application/json'

Anote el ID de la instancia. La respuesta trae las instancias a las que pueden acceder los grupos del operador.

Consulte un usuario existente

curl -s "$API_BASE/stcpcore/v2/instances/id/<instanceID>/users" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Accept: application/json'

Guarde un usuario similar al que va a crear, por ejemplo en usuario.json. Sirve de modelo para el CONFIG_TXT. Los campos y los valores codificados están en Estructura del CONFIG_TXT.

Cree el usuario

En el archivo, elimine el campo ID, cambie el NAME y los campos necesarios del CONFIG_TXT, y envíe:

curl -s -X POST "$API_BASE/stcpcore/v2/instances/id/<instanceID>/users" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @usuario.json

Respuesta:

{"data": "SOCIO02", "field": "user"}

Importante

El header debe ser exactamente Content-Type: application/json. Con cualquier otro valor, incluso con charset, la API responde 400.

Modifique o elimine

Para modificar, envíe la entidad completa con PUT en la ruta del usuario. El CONFIG_TXT enviado sustituye por completo al guardado: parta siempre de una consulta actual. Los campos enmascarados (****) mantienen el valor guardado.

curl -s -X PUT "$API_BASE/stcpcore/v2/instances/id/<instanceID>/users/id/<userID>" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @usuario.json

curl -s -X DELETE "$API_BASE/stcpcore/v2/instances/id/<instanceID>/users/id/<userID>" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Cree el buzón y pruebe la conexión

Con el usuario creado, use la supervisión para crear la estructura de directorios del buzón e iniciar una conexión de salida:

curl -s -X POST "$API_BASE/stcpadminsvc/v2/supervision/stcpmon/user/create_folder" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"Instance": "STCPGEMINI", "Name": "SOCIO02"}'

curl -s -X POST "$API_BASE/stcpadminsvc/v2/supervision/stcpmon/user/start" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"Instance": "STCPGEMINI", "Name": "SOCIO02"}'

Los comandos exigen que los servicios de supervisión estén registrados. Vea Servicios de supervisión.

Otras tareas

Tarea	Endpoint
Desbloquear un usuario	`POST /stcpadminsvc/v2/supervision/stcpauth/reset/user/lock` con `{"Instance": "...", "Name": "..."}`
Restablecer la contraseña de un usuario	`POST /stcpadminsvc/v2/supervision/stcpauth/reset/user/password` con `NewPassword`
Ejecutar una agenda en el momento	`POST /stcpadminsvc/v2/supervision/stcpmon/schedule/start` con `{"Instance": "...", "Name": "<agenda>"}`
Probar un nombre de archivo en los tipos de archivo	`GET /stcpcore/v2/instances/id/{instanceID}/ftypesglobal/check?filename=<nombre>`

Consultar informes