README

NAVI API

Descrição

O NaviAPI é uma biblioteca PHP que fornece serviços para consulta de CEP, CPF e CNPJ. Ele utiliza a estrutura do Laravel para configuração e integração.
O serviço é fornecido pela NaviAPI.
Acesse o site para verificar a documentação e os planos disponíveis.

Requisitos

• PHP 8.1 ou superior
• Composer
• Laravel 10.x ou superior

Instalação

1. Adicione o pacote ao seu projeto via Composer:

   composer require luizfabianonogueira/navi-api

2. Em bootstrap/providers.php adicione o provider.

   <?php
   return [
       // other providers...
       LuizFabianoNogueira\NaviAPI\NaviAPIServiceProvider::class, 
   ];

3. Publique as configurações do pacote:

   php artisan vendor:publish --tag=navi-api-config

4. Configure as variáveis de ambiente no arquivo .env:

   NAVI_API_URL=https://api.exemplo.com
   NAVI_API_TOKEN=seu_token_aqui
   NAVI_API_INTERNAL_URL=false

5. Execute o comando abaixo para aplicar as configurações:

   php artisan config:cache

Uso

Exemplo de Uso no Controller

<?php

namespace App\Http\Controllers;

use LuizFabianoNogueira\NaviAPI\NaviAPIService;

class HomeController extends Controller
{
    public function index()
    {
        $naviAPIService = new NaviAPIService();

        // Exemplo de consulta de CEP
        $cep = $naviAPIService->cep('#####-###');
        dump($cep);

        // Exemplo de consulta de CPF
        $cpf = $naviAPIService->cpf('###.###.###-##');
        dump($cpf);

        // Exemplo de consulta de CNPJ
        $cnpj = $naviAPIService->cnpj('##.###.###/####-##');
        dump($cnpj);

        return view('home');
    }
}

URLs Internas.

Para facilitar seu uso adicionamos um acesso direto pela url de seu sistema para que possa usar a API sem precisar de programar.

URLs

• CEP: https://yourdomain.com/navi-api/cep/{cep}
• CPF: https://yourdomain.com/navi-api/cpf/{cpf}
• CNPJ: https://yourdomain.com/navi-api/cnpj/{cnpj}

License: LGPL-3.0-or-later

Contact & Support

📞 Phone: +5548991779088
✉️ Email: luizfabianonogueira@gmail.com

Support My Work

If you enjoyed this project and would like to support my work, any donation via Pix is greatly appreciated!
Feel free to donate using one of the following Pix keys:

💳 Email Pix Key: luizfabianonogueira@gmail.com
📱 Phone Pix Key: 48991779088

Thank you for your support!