Guia da API REST e Webhooks para Desenvolvedores
Documentação técnica dos endpoints de reservas, propriedades, hóspedes e eventos de Webhook em tempo real.
A API REST do Ayrton permite que desenvolvedores e empresas de tecnologia integrem a plataforma a seus próprios sistemas corporativos, ERPs, sistemas de contabilidade e dispositivos IoT de automação residencial. ### Padrões Globais de Desenvolvimento - **Arquitetura**: RESTful com payloads padronizados em JSON. - **Autenticação**: Bearer Token via HTTP Header (`Authorization: Bearer <seu_token_api>`). - **Rate Limiting**: 1.000 requisições por minuto por chave API. ### Principais Endpoints Disponíveis - `GET /v1/properties`: Lista todas as propriedades cadastradas com atributos detalhados. - `GET /v1/reservations`: Consulta histórico e novas reservas ativas com filtros por data e canal de origem. - `POST /v1/guests/checkin`: Registra dados de pre-check-in realizados via aplicações terceiras. ### Webhooks em Tempo Real Configure URLs de callback para receber eventos instantâneos no momento exato de suas ocorrências: - `reservation.created`: Disparado quando entra uma nova reserva. - `reservation.cancelled`: Disparado quando ocorre um cancelamento. - `checkin.completed`: Disparado quando o hóspede conclui a biometria facial.
Passos Recomendados
- Acesse seu painel administrativo no Ayrton com seu login e senha.
- Navegue até o menu de Configurações > Integrações.
- Siga as instruções de sincronização e autorize a permissão necessária.
Esta resposta ajudou você?
Se precisar de suporte extra, fale com nosso time de implantação.