Download the PHP package edgvi10/integration-controller without Composer

Integration Controller

Uma biblioteca PHP flexível para realizar requisições HTTP e integrar com APIs REST de forma simples e eficiente.

📋 Requisitos

• PHP >= 7.4
• Extensão cURL habilitada

📦 Instalação

Via Composer

Instalação Manual

1. Clone o repositório:

2. Inclua o autoloader do Composer no seu projeto:

🚀 Uso Básico

Inicialização

📖 Exemplos de Uso

1. Requisição GET Simples

2. Requisição POST com Dados JSON

3. Autenticação Bearer Token

4. Autenticação Basic

5. Autenticação API Key

6. Requisição PUT

7. Requisição PATCH

8. Requisição DELETE

9. Configuração Avançada de Requisição

10. Adicionando Campos Dinamicamente

11. Requisição com Retry (Tentativas Automáticas)

12. Requisição Assíncrona

13. Logging Habilitado

14. Trabalhando com Respostas

15. Múltiplas Requisições com Mesma Instância

16. Configurando SSL e Timeout

17. Enviando Array de Valores em Parâmetros

18. Usando os atalhos para Verbos HTTP

🔧 Métodos Disponíveis

Métodos de Configuração

• setBaseURL($url) - Define a URL base
• setUseJson($bool) - Define se usa JSON automaticamente
• setAuthentication($type, $auth) - Configura autenticação
• setMethod($method) - Define o método HTTP
• setEndpoint($endpoint) - Define o endpoint
• setHeaders($values) - Define headers personalizados
• addHeader($key, $value) - Adiciona um header personalizado
• rmHeader($key, $conditionalValue = null) - Remove um header personalizado, opcionalmente filtrando pelo valor
• setParams($params) - Define parâmetros de query string
• setData($data) - Define dados do body
• addField($key, $value) - Adiciona um campo ao body
• addFile($key, $fileResource) - Adiciona um arquivo ao body

Métodos de Requisição

• send() - Envia a requisição configurada
• sendAsync($callbackSuccess, $callbackError) - Envia requisição assíncrona
• sendWithRetry($maxRetries, $delaySeconds) - Envia com tentativas automáticas
• get($endpoint, $params) - Requisição GET
• post($endpoint, $data, $params) - Requisição POST
• put($endpoint, $data, $params) - Requisição PUT
• patch($endpoint, $data, $params) - Requisição PATCH
• delete($endpoint, $params) - Requisição DELETE

Métodos de Resposta

• jsonResponse() - Retorna resposta decodificada como JSON
• responseStatusCode - Código de status HTTP
• responseBody - Body da resposta
• responseHeaders - Headers da resposta

Métodos de Limpeza

• clear() - Limpa tudo
• clearRequest() - Limpa dados da requisição
• clearResponse() - Limpa dados da resposta
• clearLogs() - Limpa logs
• clearLastError() - Limpa último erro

Métodos de Log

• log($message, $data) - Registra uma mensagem de log

⚙️ Propriedades Configuráveis

🔐 Tipos de Autenticação Suportados

1. Bearer Token: Para APIs que usam tokens JWT ou OAuth
2. Basic Auth: Para autenticação básica HTTP
3. API Key: Para APIs que usam chaves em headers personalizados

🐛 Tratamento de Erros

✅ Pendencias

• [ ] Implementar lógica de retry com backoff exponencial
• [ ] Adicionar suporte para autenticação OAuth2
• [ ] Adicionar suporte para opções personalizadas do cURL
• [ ] Tratamento de tipos de conteúdo baseado nos dados da requisição
  • [x] Adicionar suporte básico para content type application/json
  • [ ] Adicionar suporte básico para content type application/xml
  • [ ] Adicionar suporte básico para requisições multipart/form-data
• [ ] Melhorar tratamento de erros e logging
• [ ] Adicionar suporte para requisições assíncronas usando curl_multi ou outras bibliotecas

📝 Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para mais detalhes.

👤 Autor

Eduardo Vieira

• Email: [email protected]
• GitHub: @edgvi10
• LinkedIn: Eduardo Vieira

🤝 Contribuindo

Contribuições, issues e solicitações de recursos são bem-vindas!

⭐ Suporte

Se este projeto foi útil para você, considere dar uma estrela no GitHub!