Tarefas manuais na plataforma Awardco, como carregar arquivos de usuários ou gerar relatórios, podem ser tediosas e demoradas. Usando chaves de API, você pode automatizar esses processos, economizando tempo e esforço. Este artigo explica o que são chaves de API, suas capacidades e como você pode usá-las dentro da sua organização por meio da Ferramenta de Gerenciamento de Chaves de API.
O que é API?
API (Interface de Programação de Aplicações) é uma forma de dois programas se comunicarem. Ela fornece um conjunto de comandos e solicitações que um programa (como o Awardco) pode aceitar de fontes externas. A maioria dos aplicativos móveis usa APIs para se comunicar com seus sistemas principais.
A API do Awardco usa HTTP, o mesmo protocolo usado por sites, simplificando a comunicação e permitindo que chamadas de API sejam feitas diretamente de um navegador.
A API do Awardco suporta dois principais tipos de requisição:
- GET: Solicita informações do banco de dados, como a recuperação de relatórios em formato .csv ou .json.
- POST: Atualiza informações no banco de dados. Por exemplo, permite atualizar usuários, registrar reconhecimentos ou gerenciar recompensas.
O que é possível com a API?
Casos de uso comuns para a API do Awardco incluem:
- Carregar arquivos de usuários para o Awardco.
- Obter relatórios em formato .csv ou .json.
- Automatizar prêmios e reconhecimentos.
- Recuperar informações do feed social para exibição.
- Interagir com a plataforma para criar aplicações.
Para enviar um arquivo usando uma API, o arquivo deve estar acessível e devidamente codificado. Existem três métodos principais para isso:
- Armazenar o arquivo em um servidor FTP ou servidor acessível publicamente.
- Usar um serviço de API (por exemplo, Postman) para construir a solicitação.
- Usar linguagens de programação como C#, cURL ou JavaScript para enviar a solicitação.
Embora a API forneça acesso poderoso à plataforma Awardco, os clientes são totalmente responsáveis pelo seu uso.
Para saber mais, visite nossa Documentação Pública da API.
Habilitando a Permissão de Chave de API
Por padrão, apenas usuários Super Admin podem gerenciar chaves de API. Para permitir que outros papéis gerenciem e criem chaves de API:
- Clique no botão Admin no canto superior direito da página inicial.
- Navegue até a aba Configurações.
- Selecione Permissões no menu à esquerda.
- Clique no ícone de três pontos ao lado do papel que deseja editar e escolha Editar.
- Vá para as configurações de Permissões e marque a caixa ao lado de ‘Chaves de API’.
- Clique em Salvar & Aplicar.
Acessando a Ferramenta de Gerenciamento de Chaves de API
O Awardco oferece uma ferramenta dedicada de Gerenciamento de Chaves de API que permite gerenciar chaves específicas para várias ações, como enviar reconhecimentos, puxar feeds ou criar usuários. Em vez de usar uma única chave de API poderosa, o Awardco divide as chaves em ações separadas conforme suas necessidades.
Para acessar a ferramenta de Gerenciamento de Chaves de API:
- Selecione o botão 'Admin' no canto superior direito da página inicial.
- Clique na aba 'Configurações'.
- Clique em 'Chaves de API' no menu à esquerda.
Na Ferramenta de Gerenciamento de Chaves de API, você pode:
- Visualizar e gerenciar chaves específicas para diferentes tarefas (por exemplo, enviar reconhecimentos, puxar relatórios).
- Atribuir papéis e permissões para quem pode gerenciar chaves de API dentro da sua organização.
- Rastrear quem criou cada chave de API e quando ela foi criada.
- Garantir que as chaves de API sejam hashadas e salgadas para segurança (não são armazenadas em texto simples).
- Excluir chaves de API conforme necessário.
- Observar que usuários que estão se passando por outros não podem gerar chaves de API.
- Enviar chaves de API com segurança para pessoas confiáveis.
Criando uma Nova Chave de API
Para criar uma nova chave de API:
- Clique no botão + Nova Chave de API na página de Chaves de API.
- Digite um Nome para a Chave.
- Selecione as permissões que a chave deve ter.
- Se você estiver configurando uma chave de API para uma integração Awardco, veja a seção Permissões Requeridas para Integração abaixo.
- Defina o período ou data de expiração da chave.
- A data máxima de expiração é três anos a partir da data atual. Recomenda-se trocar as chaves de API regularmente.
- Clique em Avançar.
- Escolha gerar a chave imediatamente ou enviá-la com segurança para outra pessoa.
- Revise os detalhes e conclua o processo clicando em Gerar Chave de API ou enviando-a com segurança.
Importante: Copie e armazene a chave de API com segurança imediatamente após gerá-la. Por motivos de segurança, ela não será exibida novamente. Para mais informações sobre melhores práticas e dicas para Chaves de API, consulte este artigo de suporte.
Gerenciando Chaves de API
Visualizando e Editando Detalhes da Chave de API
Para visualizar os detalhes de uma chave de API:
- Clique no nome da Chave de API para abrir uma janela de detalhes mostrando:
- Nome da chave.
- Seis primeiros dígitos da chave.
- Nome do criador.
- Status.
- Permissões.
- Data de criação.
- Data de expiração.
- Data do último uso.
Para editar o nome ou a data de expiração de uma chave de API, clique em Editar e faça as alterações. Salve suas mudanças quando terminar.
Revogando uma Chave de API
Revogar uma chave de API a desativa permanentemente, tornando quaisquer integrações associadas não funcionais. Esta ação não pode ser desfeita.
Para revogar uma chave de API:
- Clique no ícone de três pontos ao lado da chave.
- Selecione Revogar.
- Confirme clicando em Revogar Chave de API.
Chaves revogadas serão movidas para a aba Arquivadas.
Reenviando uma Chave de API
Se uma chave de API mostrar o status “Não Aceita” ou não for aceita dentro de 24 horas, você pode reenviá-la.
- Clique no ícone de três pontos ao lado da chave.
- Selecione Reenviar. A chave de API será reenviada para o endereço de e-mail especificado quando a chave foi criada.
Clonando uma Chave de API
Para clonar uma chave de API:
- Clique no ícone de três pontos ao lado da chave e selecione Clonar.
- Atualize o nome, permissões ou data de expiração conforme necessário.
- Siga o mesmo processo para gerar ou enviar a chave conforme descrito em “Criando uma Nova Chave de API.”
Visualizando Chaves Arquivadas
Para visualizar chaves de API revogadas ou arquivadas, navegue até a aba Arquivadas nas configurações de Chaves de API. Chaves revogadas não podem ser restauradas, mas podem ser clonadas para criar uma duplicata.
Transição das Chaves de API Clássicas
Embora as chaves de API clássicas continuem funcionando por enquanto, recomendamos migrar para o novo sistema para maior segurança e melhor controle sobre suas integrações.
Encontrando Sua Chave de API Clássica
Sua chave de API clássica foi movida de Admin > Configurações > Configurações Avançadas para a nova Página de Gerenciamento de Chaves de API. Agora você pode encontrá-la na parte inferior da página de Configurações de API (Admin > Configurações > Chaves de API).
Como Migrar das Chaves de API Clássicas
Para fazer a transição segura da sua chave de API clássica:
- Crie Novas Chaves com Permissões: Gere chaves de API separadas para cada integração usando os passos em "Criando uma Nova Chave de API" acima. Garanta que cada chave tenha apenas as permissões específicas necessárias para sua integração.
- Atualize Suas Integrações: Substitua a chave de API clássica em cada integração pela nova chave com permissões apropriadas.
- Exclua Sua Chave de API Clássica: Uma vez que todas as integrações estejam atualizadas, clique no botão "Excluir Chave de API Clássica" na parte inferior da página de Configurações de API.
Permissões Requeridas para Integração
Uma lista de integrações que usam chaves de API e a permissão necessária para cada uma:
- ScreenCloud - Feed Personalizado
- Qualtrics - Reconhecimento Externo
- Speakap - Feed Social
- Sworkit - Recompensa em Massa
- Paycom - Importar Usuários
- Awardco Connect (para todos os clientes) - Um representante Awardco irá orientá-lo sobre as permissões específicas que sua chave de API requer. Na maioria dos casos, apenas algumas permissões são necessárias.
If you have any questions, please contact Awardco Admin Support.