Giter VIP home page Giter VIP logo

nfemail-sdk's Introduction

NfeMail SDK - Não oficial

Essa é uma biblioteca, não oficial, para acessar facilmente a API do http://www.nfemail.com.br. Para acessar a api você precisa de uma chave de acesso e para isso entre em contato com suporte que irão disponibilizar para você.

Para acessar a documentação da API do NfeMail acesse: (http://www.nfemail.com.br/Manualapi/)

Instalação

Metodo 1 - Usando o Composer

Quem quiser pode usar composer para facilitar o trabalho e basta executar:

composer require wallacesilva/nfemail-sdk

Metodo 2 - Manual

Baixe ou clone o repositorio completo. Depois adicione(require) o arquivo autoload.php no seu projeto. Faça o download aqui

# informe o caminho para o projeto corretamente, se necessário
require_once(__DIR__.'/nfemail-sdk/autoload.php');

Requisitos

  • PHP 5.6+ (sugerido 7.1+)

Como usar

Para usar é simples basta chamar uma instancia e fazer os request. Veja abaixo exemplos básicos, para mais exemplos veja na pasta de exemplos em examples/.

Chamar instancia principal

$cnpj = 'cnpj aqui';
$apikey = 'chave de acesso'; 
$nfemail = new \NfeMail\NfeMail($cnpj, $apikey);

Listar Clientes

$clientes = $nfemail->getClientes();

# Retorna lista com 10 clientes
$clientes->all(1, 10)->toArray();

# Retorna o cliente encontrado pelo id
#$clientes->findById(45)->toArray();

# Retorna o cliente encontrado pelo Cpf/Cnpj
#$clientes->findByCpfCnpj(12345678912)->toArray();

Exemplos

Caso tenha dúvidas e queira ver formas de usar essa SDK acesse a pasta examples que contem alguns exemplos de uso.

Dúvidas e Problemas

Caso tenha problemas e/ou dúvidas crie uma nova issue aqui (https://github.com/wallacesilva/nfemail-sdk/issues)

TODO

Aqui algumas coisas que precisa ser feito e você pode ajudar com um pull request.

  • Criar Provider para usar no Laravel/Lumen Framework;
  • Adicionar mais exemplos de consumo da api;
  • Criar testes básicos;
  • Add projeto no packagist/composer;

Versionamento

O ideal é trabalhar com o padrão SEMVER, muito comum no mundo de software e linux, porém essa é uma versão por enquanto, caso não conheça saiba mais em (http://semver.org/).

Licença

A linceça desse projeto é a MIT License, por favor, verifique se isso interfere na politica da sua empresa, antes de usar o projeto.

nfemail-sdk's People

Contributors

wallacesilva avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.