GET | Listar um segredo de API por [identifier]
  • 2 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

GET | Listar um segredo de API por [identifier]

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

storAcesse informações de um segredo de API armazenado no MySafe.

Requisito

  • Permissão de acesso ao segredo de API

Requisição

GET api/mysafe/secretapi/[identifier]

Parâmetros de requisição

Envie o parâmetro abaixo no path da URL.

identifier - int - obrigatório - Código único de identificação do segredo de API.Nota: esse valor é automaticamente atribuído pelo segredo de senhasegura em POST | Criar segredo de API e é obtido na resposta da requisição GET | Listar todos os segredos de APIs.

Exemplo de requisição

GET {{url}}api/mysafe/secretapi/3.

Resposta

HTTP/1.1 200 OK 
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Success",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Success",
        "erro": false,
        "cod_erro": 0
    },
    "api_secret_entity": {
        "identifier": "3",
        "name": "GCP1",
        "url": "https://gcp1.com",
        "client_secret": "hy7464g5v8ghy4d858jk7fds57t4tr",
        "client_id": "hb455f7g8fg9dfg8yt845bxxku",
        "identifier_code": "12534",
        "method": "get",
        "tags": "Cloud1",
        "notes": "Access details for this API secret",
        "users_allowed": [
            {
                "name": "alices",
                "can_edit": true
            }
        ],
        "groups_allowed": []
    }
}

Campos do corpo da resposta

api_secret_entity - objeto - Dados do segredo de API armazenado.


    →identifier - string - Código único de identificação do segredo de API.


    →name - string - Nome atribuído ao segredo de API.


    →url - string - URL do site onde o segredo de API está sendo usado.


    →client_secret - string - O segredo de API usado para autenticar a aplicação.


    →client_id - string - ID da aplicação cliente.


    →identifier_code - string - String única definida pelo usuário para identificar o segredo de API.


    →method - string - O método HTTP a ser usado para na chamada de API.


    →notes - string - Observações sobre o segredo da API.


    →tags - string - Palavras-chave associadas ao segredo de API.


    →users_allowed - array de objetos - Dados dos usuários com acesso ao segredo de API.


    →groups_allowed - array de objetos - Dados dos grupos com acesso ao segredo de API.

Erros

400 - Bad Request.

Mensagem: "1010: Unexpected identifier type"

Possível causa: o identifier enviado não foi reconhecido como válido.

Solução: verifique o valor do identifier e envie a requisição novamente.

Mensagem: "1005: Api secret not found"

Possível causa: segredo de API não encontrado.

Solução: verifique o valor do identifier e envie a requisição novamente.

Mensagem: "1006: User does not have access"

Possível causa: usuário não possui acesso ao segredo de API.


Mensagem: "1009: Inactive Api secret"

Possível causa: segredo de API inativo.

Solução: ative o segredo de API através do POST api/mysafe/password/active[identifier].
500 - Internal Server Error.

Mensagem: "Unexpected error."

Possível causa: o erro está no servidor senhasegura.

Solução: contate o time de suporte para mais informações.


No route matched with those values.

Mensagem: "No route matched with those values."

Possíveis causas: falha na autenticação da sua aplicação com o servidor senhasegura ou URL incorreta.

Solução: verifique os parâmetros de autenticação como Access Token URL, Client ID e Client Secret e solicite um novo token de acesso ou verifique e corrija a URL.


An invalid response was received from the upstream server .

Mensagem: "An invalid response was received from the upstream server

Possível causa: o servidor upstream pode estar demorando muito para responder, levando a um erro de timeout que é interpretado como uma resposta inválida pelo servidor proxy/gateway.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.


The upstream server is timing out.

Mensagem: "An invalid response was received from the upstream server"

Possível causa: o tempo da requisição se esgotou.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.



Este artigo foi útil?

What's Next