README

这是一个用于 Nota Fácil API 的 PHP 客户端，您可以将它添加到项目中以轻松访问以下功能。

• 认证

为此，您需要在 Nota Fácil 上注册一个有效的 Softhouse 账户。

有关 API 操作和签约的信息，请访问我们的网站 我们的网站。

内容列表

• 文档
• 一般信息
• 安装
  • 通过 composer
  • 不通过 composer
• 快速开始
  • 认证
    • 认证 Nota Fácil API 的要求
    • 认证 Nota Fácil API
• 有问题？

文档

您可以在此处访问 Nota Fácil API 的官方文档。.

--

一般信息

我们使用 语义版本 进行版本控制。

在 MIT 许可证 下发布

安装

通过 Composer

要开始使用此库，将其作为依赖项添加到您的 composer.json 文件中，如下所示。

"require":{
    "notafacil-io/php-common-notafacil": "^1.0"
}

现在只需执行 composer install 命令即可下载依赖项。或者，在终端中运行以下命令。

composer require notafacil-io/php-common-notafacil

不通过 Composer

如果您的项目阻止您使用 composer，您可以手动下载此包及其所有依赖项，并从您的代码中引用它们。然而，存在可以自动化此过程的解决方案。其中之一是在线工具 php-download。您可以使用它找到 PHP Client Nota Fácil，从该网站下载它并在项目中使用，无需手动收集依赖项。

--

快速开始

认证

认证 Nota Fácil API 的要求

要执行认证并获取 Bearer 令牌，您必须具备以下数据。

• login（登录用户）
• password（用户密码）
• secret_key（验证密钥）

提醒/警报

注意您的 API 密钥：认证密钥可以执行我们 API 上的任何操作，因此您必须将其保存在安全的地方。

认证 Nota Fácil API

这是一个简单示例，用于在我们的 API 上进行认证。如果无法认证，将抛出异常。

<?php

include_once(__DIR__.'/../../vendor/autoload.php');


use NotaFacil\Common\Services\AuthNotaFacil;
use NotaFacil\Common\Exceptions\NotaFacilException;

try {
    
    $credentials = [
        "login" => "LOGIN_SOFTHOUSE",
        "password" => "SENHA_SOFTHOUSE",
        "secret_key" => "SECRET_KEY_SOFTHOUSE"
    ];

    $clientNotaFacil =(new AuthNotaFacil())->attempt($credentials)
                       // ->getResponse();
                       ->getDataAuth();

    dump($clientNotaFacil);

} catch (NotaFacilException $th) {
    dump($th->getMessage(), $th->getCode());
}

您还可以在此文件夹 ./exemple/authentication/SimpleLogin.php 中查看此示例，并使用以下命令进行测试 php -S localhost:8000 ./exemple/authentication/SimpleLogin.php

--

有问题？

对于任何问题或功能请求，请随时在我们的存储库中打开一个 issue。有关发送请求的详细信息，请查看 CONTRIBUTING 文件。

如果有什么需要我们立即关注的问题，请随时通过以下邮箱联系我们 suporte@notafacil.io。