Gerenciar recursos

Este guia mostra as operações mais comuns de gestão. Antes de começar, obtenha um token conforme Autenticação e defina as variáveis:

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

O contrato de todos os endpoints está na Especificação OpenAPI e as convenções em Recursos de gestão.

Liste as instâncias

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

Anote o ID da instância. A resposta traz as instâncias que os grupos do operador podem acessar.

Consulte um usuário existente

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

Salve um usuário semelhante ao que vai criar, por exemplo em usuario.json. Ele serve de modelo para o CONFIG_TXT. Os campos e os valores codificados estão em Estrutura do CONFIG_TXT.

Crie o usuário

No arquivo, remova o campo ID, altere o NAME e os campos necessários do CONFIG_TXT, e envie:

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

Resposta:

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

Importante

O header deve ser exatamente Content-Type: application/json. Com qualquer outro valor, inclusive com charset, a API responde 400.

Altere ou exclua

Para alterar, envie a entidade completa com PUT no caminho do usuário. O CONFIG_TXT enviado substitui o gravado por inteiro: parta sempre da consulta atual. Campos mascarados (****) mantêm o valor gravado.

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"

Crie a caixa postal e teste a conexão

Com o usuário criado, use a supervisão para criar a estrutura de diretórios da caixa postal e iniciar uma conexão de saída:

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": "PARCEIRO02"}'

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": "PARCEIRO02"}'

Os comandos exigem que os serviços de supervisão estejam cadastrados. Veja Serviços de supervisão.

Outras tarefas

Tarefa	Endpoint
Desbloquear um usuário	`POST /stcpadminsvc/v2/supervision/stcpauth/reset/user/lock` com `{"Instance": "...", "Name": "..."}`
Redefinir a senha de um usuário	`POST /stcpadminsvc/v2/supervision/stcpauth/reset/user/password` com `NewPassword`
Executar uma agenda na hora	`POST /stcpadminsvc/v2/supervision/stcpmon/schedule/start` com `{"Instance": "...", "Name": "<agenda>"}`
Testar um nome de arquivo nos tipos de arquivo	`GET /stcpcore/v2/instances/id/{instanceID}/ftypesglobal/check?filename=<nome>`

Consultar relatórios