Download the PHP package ailos/sdk without Composer
On this page you can find all versions of the php package ailos/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package sdk
Short Description Este SDK foi desenvolvido para facilitar a integração com os serviços da Cooperativa Ailos, oferecendo uma interface simples, segura e eficiente para desenvolvedores PHP.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sdk
Ailos SDK
[
Este SDK foi desenvolvido para facilitar a integração com os serviços da Cooperativa Ailos, oferecendo uma interface simples, segura e eficiente para desenvolvedores PHP.
Requisitos
- PHP
^8.5 - Extensão
curlhabilitada
Instalação
Ambientes
O SDK suporta dois ambientes. Por padrão, o ambiente é homologacao.
| Ambiente | Descrição | Base URL |
|---|---|---|
homologacao |
Testes e desenvolvimento | https://apiendpointhml.ailos.coop.br |
producao |
Ambiente real | https://apiendpoint.ailos.coop.br |
Para alternar entre eles, basta passar o ambiente desejado na instanciação do SDK:
Autenticação
O processo de autenticação da API Ailos é composto por três etapas realizadas automaticamente pelo SDK:
- Geração do Access Token — usando suas credenciais de aplicação (Consumer Key e Consumer Secret)
- Obtenção do ID — usando o Access Token junto com os dados da sua aplicação
- Autenticação do Cooperado — usando o Access Token e o ID para autenticar o cooperado, cujo resultado (JWT) é enviado para a URL de callback configurada
O SDK gerencia todo esse fluxo internamente, incluindo a renovação automática dos tokens antes de expirarem.
Credenciais necessárias
Para utilizar o SDK você precisará de:
| Credencial | Descrição |
|---|---|
consumerKey |
Chave de identificação da sua aplicação |
consumerSecret |
Segredo da sua aplicação |
urlCallback |
URL do seu endpoint que receberá o JWT |
ailosApiKeyDeveloper |
UUID do desenvolvedor fornecido pela Ailos |
codigoCooperativa |
Código da cooperativa do cooperado |
codigoConta |
Código da conta do cooperado |
senha |
Senha de acesso do cooperado |
Instanciando o SDK
Após chamar authenticate(), a Ailos enviará um POST para a urlCallback configurada com o seguinte payload JSON:
O campo code contém o JWT que deve ser informado ao SDK para que a autenticação seja concluída. O SDK oferece duas abordagens para isso — escolha a que melhor se encaixa no seu contexto.
Abordagens para o endpoint de callback
Abordagem 1 — Automática com callbackHandler() ✅ Recomendada
O SDK processa o callback automaticamente. Você apenas registra uma rota apontando para o handler — sem precisar entender o payload ou extrair campos manualmente.
PHP puro:
Laravel:
Symfony:
Slim:
O callbackHandler() disponibiliza três métodos de entrada para se adaptar a qualquer contexto:
| Método | Quando usar |
|---|---|
handleFromGlobals() |
PHP puro — lê automaticamente php://input ou $_POST |
handleFromJson(string $json) |
Frameworks que expõem o corpo como string bruta |
handleFromArray(array $data) |
Frameworks que expõem o corpo como array |
Após o processamento, todos os métodos retornam um CallbackPayload com acesso ao state — útil para correlacionar o callback com a sessão que o originou:
Abordagem 2 — Manual com handleCallback() 🔧 Controle total
Para casos onde você precisa processar o payload manualmente antes de informar o JWT ao SDK — por exemplo, validar o state, registrar logs ou aplicar lógica customizada.
Quando preferir a Abordagem 2:
- Você precisa validar o
stateantes de aceitar o JWT - Você quer registrar logs detalhados do payload recebido
- Você precisa de lógica de negócio customizada no callback
- Você está integrando com um sistema de autenticação próprio
Utilizando o JWT nas chamadas à API
Independente da abordagem escolhida para o callback, o uso do JWT é idêntico. O SDK renova o token automaticamente quando necessário:
Encerrando a sessão
Tratamento de erros
Todas as exceções do SDK herdam de AilosSdkException, permitindo capturar qualquer erro com um único catch. Para tratamentos mais específicos, utilize as exceções tipadas:
As exceções do callbackHandler() seguem o mesmo padrão:
Hierarquia de exceções
Contribuindo
Contribuições são bem-vindas! Para contribuir:
- Faça um fork do repositório
- Crie uma branch para sua feature:
git checkout -b feat/minha-feature - Commite suas alterações seguindo Conventional Commits
- Abra um Pull Request descrevendo as mudanças
Por favor, certifique-se de que os testes passam e o code style está correto antes de abrir o PR:
Licença
Vinícius de Senna
Contribuidores
All versions of sdk with dependencies
ext-libxml Version *
ext-dom Version *