Download the PHP package jcf/auvo without Composer
On this page you can find all versions of the php package jcf/auvo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package auvo
Short Description Pacote Laravel para integração com a API do Auvo - Sistema de gestão de serviços de campo (field service management)
License MIT
Homepage https://github.com/jotacfurtado/auvo-laravel
Informations about the package auvo
Jcf/Auvo
Pacote Laravel para integração com a API do Auvo - Sistema de gestão de serviços de campo (field service management).
Instalação
Configuração
Publicar o arquivo de configuração:
Configurar as variáveis de ambiente no arquivo .env:
Importante: A API Key e API Token podem ser obtidos em Menu > Integração na sua conta Auvo.
Autenticação
O pacote gerencia automaticamente a autenticação JWT com a API do Auvo. Os tokens têm validade de 30 minutos e são renovados automaticamente quando necessário.
Nota importante: A API Auvo não suporta refresh token. Quando o token expira (após 30 minutos), o pacote faz automaticamente um novo login.
Métodos de Autenticação
Uso
Consultas Básicas
Objeto de Resposta AuvoResponse
Requisições GET que retornam listas retornam um objeto AuvoResponse com métodos úteis para acessar dados e metadados da resposta:
Paginação Automática
O pacote oferece métodos para buscar automaticamente todos os registros, iterando sobre todas as páginas da API:
Nota: O método
getAll()itera automaticamente sobre todas as páginas, fazendo múltiplas requisições à API. Use com cuidado para não exceder o limite de 400 requisições por minuto.
Query Builders Disponíveis
O pacote oferece Query Builders completos para os seguintes recursos:
Users (Usuários)
Tasks (Tarefas)
Customers (Clientes)
Teams (Equipes)
Operações CRUD
Todos os Query Builders suportam operações completas de CRUD:
Filtros Genéricos
Todos os Query Builders suportam filtros genéricos com o método where():
Rate Limiting
Importante: A API Auvo tem limite de 400 requisições por minuto por endereço IP.
Se o limite for excedido, você receberá uma exception RateLimitException. O pacote detecta automaticamente quando o rate limit é atingido.
Características
- ✅ Autenticação JWT automática
- ✅ Renovação automática de tokens (novo login após 30 minutos)
- ✅ Tratamento automático de erros de autenticação
- ✅ Query Builders estilo Laravel para recursos core
- ✅ Suporte completo a CRUD (GET, POST, PATCH, DELETE)
- ✅ Métodos específicos para filtros comuns
- ✅ Suporte a filtros genéricos com
where() - ✅ Objeto de resposta AuvoResponse para acesso simplificado aos dados
- ✅ Métodos mágicos de Collection em AuvoResponse
- ✅ Paginação automática com
getAll()eallPages() - ✅ Retorna Collections em vez de arrays para melhor manipulação
- ✅ Métodos auxiliares para paginação manual (
page(),pageSize()) - ✅ Seleção de campos específicos (
selectFields()) - ✅ Método
first()para buscar entidades únicas - ✅ Detecção automática de rate limit
- ✅ Logs de requisições (opcional)
- ✅ Configuração via variáveis de ambiente
- ✅ Testes unitários e de integração completos
Exceptions
O pacote lança exceções específicas para diferentes tipos de erro:
AuvoException- Erro genérico da APIAuthenticationException- Erro de autenticação (401, 403)NotFoundException- Recurso não encontrado (404)ValidationException- Erro de validação (400, 422)RateLimitException- Rate limit excedido (403 com mensagem específica)
Documentação da API
A documentação completa da API Auvo v2 está disponível em:
docs/api/auvoapiv2.apib- Especificação API Blueprint
Requisitos
- PHP ^8.1
- Laravel ^10.0|^11.0|^12.0
Testes
Licença
MIT
Suporte
Para issues e dúvidas, utilize o repositório no GitHub.
Créditos
Desenvolvido por João C. Furtado.
All versions of auvo with dependencies
php Version ^8.2
illuminate/support Version ^11.0|^12.0
illuminate/http Version ^11.0|^12.0