# Chaves Api

A seção **Chaves API** em RUFUS Cloud permite gerar e gerenciar chaves API para integrar seus dispositivos e software de cronometragem com RUFUS Cloud por meio do [**RUFUS Public API**](https://help.runonrufus.com/public-api/). Essa funcionalidade permite acessar e gerenciar remotamente seus dispositivos de cronometragem, oferecendo flexibilidade e controle para todas as suas necessidades de integração.

Cada conta da empresa pode criar **até 10 chaves API**, e você pode personalizar as permissões para garantir que cada aplicativo receba apenas o nível de acesso de que precisa. A seção Chaves API é acessível clicando no seu **e-mail ou nome da empresa** no canto superior direito da barra de navegação e selecionando a guia **Chaves API**.

![](https://rufus-serverless-v1-shopmediabucket-yqa11v58uwom.s3.us-east-1.amazonaws.com/knowledge/assets/knowledge_asset_24a18e3e873d4a7a9e516c96a7184bc2/imported.png)
_Guia Teclas Api_

## Criando uma nova chave API

Para criar uma nova chave API, siga estes passos:

1. **Alias**: insira um alias para sua chave API. Este é simplesmente um rótulo para ajudar você a identificar o objetivo da chave.
2. **Tipo de acesso**: selecione o tipo de acesso apropriado para sua chave:
* **READ**: concede permissão para chamar todos os métodos **GET**. A chave pode ler informações de dispositivos, sessões e passagens.
* **WRITE**: concede permissão para chamar todos os métodos **POST** e **PATCH**. A chave pode vincular dispositivos, inserir sessões e adicionar passagens.
* **READ_WRITE**: concede permissão para chamar **todos os métodos**, incluindo GET, POST, PATCH e DELETE.
3. **Desvincular dispositivo**: para chaves **WRITE** e **READ_WRITE**, você pode alternar a opção **Permitir desvinculação de dispositivo**, que concede permissão para chamar o método **DELETE** e remover um dispositivo da conta.
4. Clique em **Criar chave API** para gerar a chave. A nova chave será exibida na lista **Chaves API ativas**.

### Gerenciando chaves ativas API

Depois que uma chave API é criada, ela aparece na lista **Chaves API Ativas**. Aqui, você pode:

* **Ver detalhes**: A lista mostra o alias, a chave API, o tipo de acesso e se tem permissão para desvincular dispositivos.
* **Excluir chaves**: se uma chave API não for mais necessária, ela poderá ser excluída desta lista para revogar suas permissões.

## Visão geral das permissões do API

* **LER**: concede permissão para chamar todos os métodos GET, o que permite que o aplicativo leia informações de dispositivos, sessões e passagens.
* **WRITE**: Concede permissão para chamar todos os métodos POST e PATCH, permitindo a vinculação de dispositivos e a inserção de sessões e passagens.
* **READ_WRITE**: Fornece acesso total, permitindo que o aplicativo chame todos os métodos (GET, POST, PATCH, DELETE).
* **Desvincular dispositivo**: esta permissão está disponível apenas para chaves API do tipo **WRITE** e **READ_WRITE**. Ela permite que um dispositivo seja excluído da sua conta chamando o método DELETE.

## Casos de uso típicos

Para ilustrar como as chaves API podem ser usadas, aqui estão alguns exemplos:

* **Dispositivos (ESCRITA)**: Crie uma chave API para seus dispositivos de temporização personalizados RFID, permitindo que eles se vinculem ao RUFUS Cloud e insiram dados de sessão.
* **Aplicativo de cronometragem (READ_WRITE)**: use uma chave API para o seu software de cronometragem ou aplicativo de cronometragem manual, concedendo acesso total para ler e gerenciar sessões e passagens.
* **Aplicativo de Classificação (LEITURA)**: configure uma chave API para o seu software de classificação, permitindo que ele leia dados como informações do dispositivo, sessões e aprovações.
* **Admin (READ_WRITE, Unbind = true)**: gere uma chave API para o seu painel de administração de tempo, com permissões completas, incluindo a capacidade de desvincular dispositivos da sua conta.

## Documentação Pública API

Para saber mais sobre como integrar seus sistemas com o RUFUS Cloud, você pode acessar a [**documentação pública do API**](https://help.runonrufus.com/public-api/). Esta documentação fornece detalhes sobre como usar os diferentes endpoints e métodos disponíveis.

## Segurança e Gestão

As chaves API são uma parte fundamental do gerenciamento seguro e eficaz da sua integração. Certifique-se de que as chaves sejam fornecidas apenas a aplicativos confiáveis e sempre exclua quaisquer chaves que não estejam mais em uso para manter a segurança do sistema. O gerenciamento adequado das suas chaves API ajudará a manter seus dados seguros e suas integrações funcionando sem problemas.