As chaves API definem como seus aplicativos interagem com o RUFUS Cloud API. Cada chave pode ter um tipo de acesso específico atribuído, permitindo que você controle exatamente quais ações uma integração pode executar.
Isso garante mais segurança, uma separação mais clara de responsabilidades e integrações mais seguras entre dispositivos, aplicativos e serviços.
Tipos de Acesso
| Tipo de acesso | Permissões |
|---|---|
| LEIA | Pode chamar todos os endpoints GET. Permite a leitura de dados como dispositivos, sessões, passagens, eventos e participantes. |
| ESCREVA | Pode chamar os endpoints POST e PATCH. Permite enviar dados (sessões, aprovações, status/telemetria do dispositivo) e criar participantes. |
| LER_ESCRITA | Acesso total a todos os endpoints GET, POST e PATCH. |
| Desvincular dispositivo | Propriedade opcional disponível para chaves WRITE e READ_WRITE. Permite o acesso a operações DELETE, como desvincular um dispositivo de uma conta. |
Observações sobre as permissões
- Relatórios de telemetria (atualizações de status do dispositivo) exigem acesso WRITE ou superior.
- A criação de participantes é restrita a chaves com permissões de ESCRITA e está sujeita aos limites do plano e à validação de propriedade.
- As atualizações e correções dos participantes são intencionalmente indisponíveis através do API público e devem ser gerenciadas através do RUFUS Race Manager (RRM).
- As operações de EXCLUIR são limitadas e protegidas e devem ser explicitamente habilitadas por meio da propriedade *Desvincular dispositivo*.
Casos de uso típicos
| Alias da chave API | Tipo de acesso | Inscrição |
|---|---|---|
| Dispositivos | ESCREVA | Usado em dispositivos RFID ou sistemas de borda para enviar sessões, passagens e dados de telemetria. |
| Aplicativo de cronometragem | LEITURA_ESCRITA | Usado em softwares de cronometragem ou aplicativos móveis que enviam e consomem dados de cronometragem. |
| Aplicativo de classificação | LEIA | Utilizado em sistemas de resultados ou classificação que precisam apenas ler eventos, participantes e passagens. |
| Administrador | LEITURA_ESCRITA + Desvincular | Usado em painéis internos ou ferramentas administrativas com controle total, incluindo o gerenciamento de dispositivos. |
Este modelo permite que você projete integrações que são seguras por padrão, ao mesmo tempo em que são flexíveis o suficiente para cobrir tudo, desde a ingestão de dispositivos de baixo nível até fluxos de trabalho completos de gerenciamento de eventos.