Configurando autenticação para API de REST do SMS Gateway

A API de REST do SMS Gateway controla a criação e a exclusão de sessões SMS. Você pode acessar a interface com o usuário da API de REST, ou em seu navegador ou conectando-se através de um aplicativo, nas seguintes URLs:

• Conexão não segura: http://<host-address:unsecured-port>/publicURL/apis/explorer/
• Conexão segura: https://<host-address:secured-port>/publicURL/apis/explorer/

Para segurança adicional, você pode configurar a autenticação básica HTTP para a API de REST. Quando a autenticação é configurada, é preciso realizar a autenticação para o envio de quaisquer solicitações API de REST.

Com a autenticação básica HTTP, é possível transmitir o nome de usuário e a senha na URL ou inseri-los quando solicitado pelo navegador. Para transmiti-los na URL, inclua-os na URL da API de REST no seguinte formato: https://<user:password>@<host address:secure port>/publicURL/apis/explorer/

Por exemplo:

https://myRESTAPIuser:Pa55w0rd@123.4.5.67:9443/publicURL/apis/explorer/

• Ambiente de locatário único: na configuração do SMS Gateway, especifique as variáveis de ambiente CTRL_TENANT_USERNAME e CTRL_TENANT_PASSWORD.

  Por exemplo, no Docker:

  - CTRL_TENANT_USERNAME=myRESTAPIuser
  - CTRL_TENANT_PASSWORD=Pa55w0rd
  

• Configuração JSON de diversos locatários: em seu arquivo JSON de configuração do locatário, configure um objeto controlCredentials com as propriedades username e password.

  "tenants": [
      {
     "tenantPhoneNumber": "+12345556789", "description":
  "Número para acessar informações da conta",
     ...
     "controlCredentials": {
       "username": "myRESTAPIuser", "password": "Pa55w0rd" }
     ...
    }
  ]