notafacil-io/php-common-notafacil

Pacote de integração Nota Fácil | PHP Common Nota Fácil

1.0.6 2021-07-12 16:13 UTC

Requires

• php: ^7.2.5

Requires (Dev)

• phpunit/phpunit: ^8.5
• symfony/var-dumper: ^5.2

MIT

• Equipe Nota Fácil
• Mauricio Lang
• Claudio Alexssandro Lino
• Matheus Falconde
• Lucas Galvão Nunes

README

Este é um PHP Client para API do Nota Fácil e você pode adicionar em seu projeto para ter acesso as seguintes funcionalidades em seu projeto de maneira fácil.

• Autenticação

Para isso, você precisa de uma conta devidademente cadastrada no Nota Fácil como Softhouse.

Para obter informações sobre o funcionamento da nossa API e contratações acesse nosso site.

Lista de conteúdo:

• Documentação
• Informações Gerais
• Instalação
  • Via composer
  • Sem composer
• Começo rápido
  • Autenticação
    • Requisitos para autenticar na API Nota Fácil
    • Autenticando na API Nota Fácil
• Problemas?

Documentação

A documentação oficial da API Nota Fácil você pode acessar aqui..

--

Informações Gerais

Para o versionamneto usamos o esquema Semantic Version

Publicado sob MIT License

Instalação

Via Composer

Para começar a usar a biblioteca, como dependência adicione em seu arquivo composer.json, como mostrado abaixo.

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

Agora basta simplesmente executar composer install para baixar as dependências. Ou rodar em seu terminal o comando abaixo.

composer require notafacil-io/php-common-notafacil

Sem Composer

Se seu projeto o impede de usar composer, você pode baixar manualmente este pacote e todas as suas dependências e referenciá-las a partir de seu código. No entanto, existem soluções que podem automatizar esse processo. Um deles é a ferramenta online php-download. Você pode usá-lo para encontrar PHP Client Nota Fácil, baixá-lo de lá e usar em seu projeto sem coletar manualmente as dependências.

--

Começo rápido

Autenticação

Requisitos para autenticar na API Nota Fácil

Para realizar a autenticação e obter o token Bearer é obrigatório que você tenha os seguintes dados.

• login (Usuário que efetuará o login)
• password (Senha do usuário)
• secret_key (Chave de validação)

Lembrete/Alerta

Cuidado com as suas chaves de API: As chaves de autenticação consegue executar qualquer operação em nossa API, então é extremamente importante que você as mantenha em um local seguro.

Autenticando na API Nota Fácil

Exemplo simples para autenticar em nossa API. Caso não seja possivel autenticar será lancado uma exeção.

<?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());
}

Você tambem pode ver esse exemplo nessa pasta ./exemple/authentication/SimpleLogin.php e testar com o seguinte comando php -S localhost:8000 ./exemple/authentication/SimpleLogin.php

--

Problemas?

Sinta-se à vontade para abrir uma issue no repositório para qualquer problema ou solicitação de recurso. Para obter detalhes de como enviar sua solicitação, verifique o arquivo CONTRIBUTING.

Se entretanto for algo que requer nossa atenção iminente, sinta-se à vontade para nos contatar [e-mail].