Download the PHP package rafapaulino/omiephpsdk without Composer

On this page you can find all versions of the php package rafapaulino/omiephpsdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of rafapaulino/omiephpsdk

Informations about the package omiephpsdk

Biblioteca de Integração com a Omie

A url para realizar os testes na api da Omie é essa: https://app.omie.com.br/developer/

Biblioteca PHP para facilitar integração com a API da Omie.

Este projeto ainda está em construção, mas já tem uma base pronta para:

Para quem é este projeto?

Para desenvolvedores iniciantes e intermediários que querem organizar uma integração com a Omie de forma simples e escalável.

Requisitos

Antes de começar, você precisa ter instalado:

Instalação

  1. Entre na pasta do projeto.
  2. Instale as dependências:

Configuração do ambiente (.env)

Este projeto lê variáveis de ambiente para montar a configuração.

  1. Crie o arquivo .env na raiz do projeto (ou copie de .env.example).
  2. Preencha os valores:

O que cada variável significa?

Uso com Laravel

O pacote suporta auto-discovery do provider via Composer.

  1. Adicione as variáveis no .env da aplicação Laravel:

  2. Publique a configuração do pacote:

  3. Injete as interfaces diretamente no container do Laravel:

Arquivo de configuração publicado: config/omie.php.

Como obter as configurações no código

A classe Config resolve automaticamente a configuração:

Arquivo: src/Config/Config.php

Exemplo:

Saída esperada (exemplo):

ConfigSingleton continua disponível por retrocompatibilidade.

Estrutura de contratos (SOLID)

As interfaces de clientes foram separadas por responsabilidade (Interface Segregation Principle).

Pasta: src/Clients/Contracts

Interfaces disponíveis:

Isso permite implementar apenas o que sua classe realmente precisa.

Contratos de users:

Contratos de vendedores:

Contratos de produtos:

Contratos de contas correntes:

Contratos de CFOP:

Contratos de categorias:

Contratos de formas de pagamento:

Service de Clientes (OmieClientService)

A implementação atual do serviço de clientes está em src/Clients/OmieClientService.php.

Métodos já implementados:

Exemplo de uso

No updateClient, se o payload não incluir codigo_cliente_omie ou codigo_cliente_integracao, o método usa o valor de $clientId como codigo_cliente_integracao.

Filtros do listClients

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Users (OmieUserService)

A implementação atual do serviço de users está em src/Users/OmieUserService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listUsers

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Vendedores (OmieSellerService)

A implementação atual do serviço de vendedores está em src/Sellers/OmieSellerService.php.

Métodos já implementados:

Exemplo de uso

Service de Produtos (OmieProductService)

A implementação atual do serviço de produtos está em src/Products/OmieProductService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listProducts

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Contas Correntes (OmieCurrentAccountService)

A implementação atual do serviço de contas correntes está em src/CurrentAccount/OmieCurrentAccountService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listCurrentAccounts

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de CFOP (OmieCfopService)

A implementação atual do serviço de CFOP está em src/CFOP/OmieCfopService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listCfop

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Categorias (OmieCategoryService)

A implementação atual do serviço de categorias está em src/Categories/OmieCategoryService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listCategories

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Formas de Pagamento (OmiePaymentMethodService)

A implementação atual do serviço de formas de pagamento está em src/PaymentMethods/OmiePaymentMethodService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listPaymentMethods

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Etapas de Faturamento (OmieBillingStepService)

A implementação atual do serviço de etapas de faturamento está em src/BillingSteps/OmieBillingStepService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listBillingSteps

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Ordens de Serviço (OmieServiceOrderService)

A implementação atual do serviço de ordens de serviço está em src/ServiceOrders/OmieServiceOrderService.php.

Métodos já implementados:

Exemplo de uso

Service de Serviços (OmieServiceService)

A implementação atual do serviço de serviços (cadastro de serviços) está em src/Services/OmieServiceService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listServices

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Service de Venda Simples (OmieSimpleSaleService)

A implementação atual do serviço de venda simples está em src/SimpleSale/OmieSimpleSaleService.php.

Métodos já implementados:

Exemplo de uso

Filtros do listOrders

Por padrão, o método envia:

Você pode sobrescrever esses valores passando o array $filters.

Testes com Pest

Os testes ficam na pasta tests.

Para rodar:

No Windows (PowerShell), se php estiver configurado no PATH:

Estado atual do projeto

Este SDK está em fase inicial. A parte de contratos e configuração já está pronta.

Próximos passos comuns:

Licença

MIT

All versions of omiephpsdk with dependencies

PHP Build Version
Package Version
Requires vlucas/phpdotenv Version ^5.6
illuminate/config Version ^12.52
illuminate/container Version ^12.52
illuminate/filesystem Version ^12.52
illuminate/support Version ^12.52
guzzlehttp/guzzle Version ^7.10
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rafapaulino/omiephpsdk contains the following files

Loading the files please wait ...