Download the PHP package engineapi/sdk without Composer
On this page you can find all versions of the php package engineapi/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download engineapi/sdk
More information about engineapi/sdk
Files in engineapi/sdk
Package sdk
Short Description SDK PHP oficial da Engine API — emissão fiscal (NFe, NFCe, NFSe) via SEFAZ, com tratamento de erro previsível
License MIT
Homepage https://docs.engineapi.com.br/sdks/php
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sdk
engineAPI — SDK PHP
SDK PHP oficial da engineAPI, a infraestrutura fiscal para desenvolvedores: NF-e, NFC-e e NFS-e por uma única API REST.
Documentação completa: docs.engineapi.com.br
Instalação
Requer PHP 8.1 ou superior.
Autenticação
Duas formas, as duas suportadas pelo SDK:
- API Key (recomendada para servidor a servidor): header
X-API-Key, sem expiração de sessão. - Login com email e senha: devolve um JWT e já o guarda no cliente para as chamadas seguintes.
Exemplo mínimo: emitir uma NF-e
Toda resposta de sucesso vem envelopada em ['data' => ..., 'meta' => ...].
O campo dos itens é items e o das formas de pagamento é pagamentos. O contrato de emissão é estrito: campo desconhecido recebe 400 apontando o nome certo, antes de consumir numeração fiscal. A lista completa de campos está no catálogo de campos da NF-e.
Módulos
NF-e
Combustíveis com tributação monofásica (CST 02 e 61)
Revenda de combustível ou GLP: o item leva o grupo combustivel (código da ANP) e o ICMS monofásico. A alíquota ad rem é em reais por unidade, não é percentual, e a base é a quantidade do produto. O valor precisa bater com quantidade × alíquota, senão a emissão é recusada com 422 antes de consumir numeração fiscal. Vale nos dois regimes, inclusive Simples Nacional.
Na NFC-e (venda ao consumidor no balcão) o leiaute aceita só o CST 61. A tributação monofásica própria (CST 02) sai em NF-e.
Empresas emissoras
Cadastro em /companies, com endereço em campos planos (address, number, city...).
Tratamento de erros
Toda falha vira EngineApiError, com o status HTTP e o corpo da resposta preservados.
A mensagem curta sai do corpo de erro no formato RFC 7807 (error.detail), o mesmo texto que a referência da API documenta.
Política de versão
Versionamento semântico (SemVer):
- MAJOR: mudança incompatível na API pública do SDK.
- MINOR: recurso novo mantendo compatibilidade.
- PATCH: correção compatível.
Cada versão publicada no Packagist corresponde a uma tag Git deste repositório (v1.2.0, por exemplo). A versão do SDK é independente da versão da API REST (/v1), que segue o próprio ciclo. As mudanças de cada versão ficam no changelog público.
Desenvolvimento
Suporte
- Documentação: docs.engineapi.com.br
- Dúvida ou defeito neste SDK: abra uma issue
- Assuntos de conta, plano ou emissão: [email protected]
- Site: engineapi.com.br
Licença
MIT. Ver LICENSE.
