api-omie

Api Omie SDK

*Aviso: Este projeto não tem ligação oficial com a Omie

SDK Multi Linguagem para integrar com a Omie API

Documentação Oficial da Omie

Recomendamos sempre consultar a documentação oficial da Omie para detalhes completos das funções disponíveis:

Omie API - Documentação Oficial

Instalação (Python)

Para instalar o pacote da Omie via pip, use o seguinte comando:

pip install api-omie

Como usar

Veja abaixo como fazer uma chamada básica para listar produtos usando a Omie API.

Exemplo de uso básico

from omieapi import Omie

omie_app = Omie('sua_app_key', 'seu_app_secret')
response = omie_app.listar_produtos(pagina=1)

print(response)

Os metodos se encontram neste formato nome_da_chamada(**argumentos)

Usando Sessões para Melhor Desempenho

Se você for fazer várias requisições à API, é altamente recomendado usar uma sessão para reutilizar a conexão e reduzir o overhead de abrir novas conexões a cada chamada. Veja como abrir e fechar uma sessão:

from omieapi import Omie

omie_app = Omie('sua_app_key', 'seu_app_secret', session=True)
response = omie_app.listar_produtos(pagina=1)
omie_app.fechar_session()

print(response)

O SDK também oferece suporte ao uso de gerenciador de contexto para abrir e fechar sessões automaticamente. Todas as chamadas com gerenciador de contexto tem por padrão o uso da sessão.

from omieapi import Omie
omie_app = Omie('sua_app_key', 'seu_app_secret')

with omie_app as r:
    response = r.listar_produtos(pagina=1)

print(response)

É possível abrir uma sessão utilizando o metodo Omie.abrir_sessão()

Exemplo de uso com httpx

from omieapi import Omie

omie_app = Omie('sua_app_key', 'seu_app_secret', use_httpx=True)
response = omie_app.listar_produtos(pagina=1)

print(response)

Ativando Logs para Depuração

from omieapi import Omie

omie_app = Omie('sua_app_key', 'seu_app_secret', log=True)
response = omie_app.listar_produtos(pagina=1)

print(response)

Contribua com este Projeto

Estamos sempre em busca de melhorias! Um dos próximos passos para este SDK é torná-lo realmente multi-linguagem, com suporte a diferentes linguagens de programação. Já existe um script de scraping que extrai os tipos complexos da API, mas ainda precisamos de ajuda para gerar o código de maneira automatizada.

Como Contribuir

• Clone o repositório
• Crie uma nova branch para suas mudanças
• Envie um pull request