# omie-sdk

> SDK da Omie para Node.js

Latest version **0.6.1** (published 2023-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install omie-sdk
pnpm add omie-sdk
yarn add omie-sdk
bun add omie-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.1 |
| Published | 2023-11-02 |
| First published | 2023-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.17.0 |
| Dependencies | 0 |
| Unpacked size | 156.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Lucas Bogos |
| Maintainers | lucasbogos |
| Keywords | omie-sdk, integração-omie, sdk-omie, api-omie, omie-plataforma, contabilidade-online, sistema-erp, integração-api, automação-financeira, gestão-empresarial, desenvolvimento-sdk, plataforma-nuvem, software-de-negócios, integração-ERP, contabilidade-digital, automação-de-processos, solução-financeira, desenvolvimento-de-software, omie-api-sdk, ferramentas-de-negócios |

## Links

- npm: https://www.npmjs.com/package/omie-sdk
- Repository: https://github.com/lucas-bogos/omie-sdk
- Homepage: https://github.com/lucas-bogos/omie-sdk#readme
- Issues: https://github.com/lucas-bogos/omie-sdk/issues
- npm.io page: https://npm.io/package/omie-sdk

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 0.6.1 (latest) — 2023-11-02
- 0.6.0 — 2023-11-02
- 0.5.0 — 2023-11-02
- 0.4.0 — 2023-11-02
- 0.3.0 — 2023-10-23

## README

# Omie SDK

## Introdução

A biblioteca Omie SDK é uma ferramenta poderosa que facilita a integração com a [plataforma Omie](https://www.omie.com.br/), permitindo que desenvolvedores criem aplicativos personalizados e automatizem processos de negócios. Esta documentação descreve como usar o Omie SDK em um ambiente TypeScript para interagir com a API do Omie.

## Requisitos

Antes de começar a usar o Omie SDK, você precisará atender a alguns requisitos:

- Node.js: Certifique-se de ter o Node.js instalado em sua máquina.
- Conta no Omie: Você precisará de uma conta no Omie para obter as credenciais necessárias para autenticação na API.
- Chave de Integração: É necessário criar uma chave de integração em sua conta Omie e conceder as permissões apropriadas para acessar os recursos desejados.

## Instalação

Você pode instalar o Omie SDK via npm (Node Package Manager) em seu projeto TypeScript:

```bash
npm install omie-sdk
```

## Uso

### Configuração

Para configurar, você pode definir as variáveis de ambiente `OMIE_APP_KEY` e `OMIE_APP_SECRET` antes de executar seu aplicativo. O Omie SDK irá ler essas variáveis automaticamente. Outra forma, seria seguindo adicionar as credenciais pelo construtor da classe:

```typescript
const credentials: ApiCredentials = {
  key: "CHAVE_API_OMIE",
  secret: "SEGREDO_API_OMIE",
};

const omieSdk = new OmieSdk(credentials);
```

Substitua "CHAVE_API_OMIE" e "SEGREDO_API_OMIE" pelas informações fornecidas pela Omie.

### Demo

Essa é uma demonstração, para mais recursos do SDK acesse nossa [documentação](./docs/README.md)!

```ts
import { OmieSdk } from "omie-sdk";

(async () => {
  const omieSdk = new OmieSdk();

  // Lista os 10 primeiros clientes
  await omieSdk.clientes.listar({
    pagina: 1,
    registros_por_pagina: 10,
  });

  // ...
})();
```

## Contribuição

Se você encontrou esta biblioteca útil e gostaria de expressar sua gratidão, você pode "pagar um café" para o mantenedor. Cada doação é uma maneira de apoiar o desenvolvimento contínuo e a manutenção desta biblioteca.

<a href="https://www.buymeacoffee.com/lucasbogos" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee"></a>

Sua contribuição é muito apreciada e ajuda a manter este projeto ativo e em constante melhoria.

Além de doações, também incentivamos a contribuição ativa para o projeto. Se você deseja colaborar com código, correções ou melhorias, sinta-se à vontade para enviar pull requests.

---
_Source: https://npm.io/package/omie-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._