Pular para o conteúdo principal
Version: 4.42

API de administração

A API de administração do Redtrust é um serviço SOAP/WCF que fornece acesso programático a todas as operações disponíveis no console de administração. É voltada para administradores e integradores que precisam automatizar tarefas de gerenciamento do Redtrust.

O que você pode fazer com a API de administração​

A API expõe as mesmas operações do console de administração. Para o conjunto completo de operações disponíveis, consulte o WSDL do serviço.

Esta documentação abrange as seguintes operações:

  • Gerenciar usuários locais: criar, editar, ativar ou desativar, desbloquear e excluir.
  • Gerenciar usuários de certificado: criar e editar.
  • Consultar informações de domínio e listar usuários.

Endpoint​

Todas as operações são realizadas contra um único endpoint:

https://SEU_IP_REDTRUST:8888/RTAdminService.svc/basic

Onde:

  • SEU_IP_REDTRUST é o endereço IP ou o nome de host do seu servidor Redtrust.
  • 8888 é a porta padrão. Você pode alterá-la no console de administração.

O WSDL do serviço está disponível em https://SEU_IP_REDTRUST:8888/RTAdminService.svc?wsdl.

Autenticação​

O endpoint /basic usa WS-Security UsernameToken sobre HTTPS. Você deve incluir as credenciais de um usuário administrador do Redtrust em cada requisição.

Para configurar o SoapUI, consulte o guia de configuração do SoapUI.

Estrutura das requisições​

As requisições seguem o formato SOAP 1.2 com o namespace urn:evolium:redtrust:administration:ws.

Estrutura das respostas​

Todas as respostas incluem um elemento Result com os seguintes campos:

CampoTipoDescrição
ResultStatusstringSUCCESS se a operação foi concluída com sucesso, ERROR se falhou.
ErrorCodestringOK em caso de sucesso. Código de erro em caso de falha.
ResultMessagestringMensagem descritiva do resultado.
ResultDatavariávelDados retornados pela operação. O tipo depende do método.
TotalItemsintegerNúmero total de itens afetados ou retornados.

Próximas etapas​