Para que serve?
Serve para criar apikey para um usuário.
Quando usar?
Esse serviço geralmente é utilizado para habilitar usuários para o consumo da API a partir da chave apikey.
Como usar?
Na chamada do serviço é preciso informar o código do usuário e identificador (alias).
O serviço deve ser executado a partir de um usuário administrador e existe um limite máximo de chaves apikey criadas por usuário.
O retorno da execução desse serviço serão os dados de identificação do usuário, como username, identificador (alias) e a apikey.
Essas informações ficam disponíveis apenas na execução do serviço e não é possível realizar consulta posterior para listar as chaves apikey disponíveis dos usuários, para tanto, é necessário armazenar essas informações para consumo futuro. Recomendamos também que essas informações sejam armazenadas de forma criptografada e que seja de acesso restrito por questão de segurança.
Para revogar uma apikey de usuário utilize o serviço: Revogar apikey para um usuário
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Links das APIs
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v1 | Documentação Técnica | 5.60 RTM 1.02 | 🟢 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada