luizfabianonogueira / navi-api

提供CPF、CNPJ和CEP查询、短信发送、TOKEN短信等服务,以集成到您的系统中。

V0.1.5 2024-09-20 18:43 UTC

This package is auto-updated.

Last update: 2024-09-20 18:47:50 UTC


README

Laravel Logo

NAVI API

描述

NaviAPI是一个PHP库,提供CEP、CPF和CNPJ查询服务。它使用Laravel结构进行配置和集成。
服务由NaviAPI提供。
访问网站以检查文档和可用计划。

许可证:LGPL-3.0-or-later

安装

要求

  • PHP 8.3或更高版本
  • Composer
  • Laravel 10.x或更高版本

步骤

  1. 通过Composer将包添加到您的项目中

    composer require luizfabianonogueira/navi-api
  2. 在bootstrap/providers.php中添加提供者。

    <?php
    return [
        // other providers...
        LuizFabianoNogueira\NaviAPI\NaviAPIServiceProvider::class, 
    ];
  3. 发布包的配置

    php artisan vendor:publish --tag=navi-api-config
  4. 在.env文件中配置环境变量

    NAVI_API_URL=https://api.exemplo.com
    NAVI_API_TOKEN=seu_token_aqui
    NAVI_API_INTERNAL_URL=false
  5. 执行以下命令以应用配置

    php artisan config:cache

用法

在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');
    }
}

内部URL。

为了方便使用,我们添加了直接通过系统URL访问的接口,这样您可以使用API而无需编程。

URL

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

联系和支持

LinkedIn WhatsApp GitHub Packagist

📞 电话: +5548991779088
✉️ 邮箱: luizfabianonogueira@gmail.com

支持我的工作

如果您喜欢这个项目并想支持我的工作,任何通过Pix的捐赠都将非常感激!
请使用以下任意一个Pix密钥进行捐赠

💳 邮箱Pix密钥: luizfabianonogueira@gmail.com
📱 电话Pix密钥: +55 48 99177-9088

感谢您的支持!