# api-ixc-soft

> SDK em TypeScript para consumir o WebService do IXC Soft e facilitar publicação/consumo via NPM.

Latest version **2.1.0** (published 2026-02-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install api-ixc-soft
pnpm add api-ixc-soft
yarn add api-ixc-soft
bun add api-ixc-soft
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2026-02-17 |
| First published | 2023-12-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 24 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Isac A |
| Maintainers | isacna |
| Keywords | ixc, api-ixc, modulo-ixc |

## Links

- npm: https://www.npmjs.com/package/api-ixc-soft
- npm.io page: https://npm.io/package/api-ixc-soft

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.9

## Recent versions

- 2.1.0 (latest) — 2026-02-17
- 2.0.0 — 2026-02-17
- 1.0.3 — 2023-12-12
- 1.0.2 — 2023-12-12
- 1.0.1 — 2023-12-12

## README

# API IXC Soft

SDK em TypeScript para consumir o WebService do IXC Soft e facilitar publicação/consumo via NPM.

## Instalação

```bash
npm install api-ixc-soft
```

## Configuração

```ts
import IXC from "api-ixc-soft";

export const ixc = new IXC({
  url: "https://HOST.com.br",
  credentials: { token: "Basic ******" },
  // ou
  // credentials: { username: "123", password: "41837b8eb82f1e60e148823a..." }
});
```

## Métodos disponíveis

### `list(table, body)`

Consulta registros com `ixcsoft: listar`.

```ts
const result = await ixc.list("cliente", {
  qtype: "id",
  query: "123",
  oper: "=",
  page: "1",
  rp: "20",
});
```

### `listFilter(table, filter)`

Consulta com filtros concatenados (`grid_param`).

```ts
const result = await ixc.listFilter("su_oss_chamado", [
  { TB: "status", OP: "=", P: "F", C: "AND", G: "status" },
  { TB: "setor", OP: "=", P: "1", C: "AND", G: "setor" },
]);
```

### `read(table, body)`

Obtém um único registro com `ixcsoft: obter`.

```ts
const result = await ixc.read("cliente", { id: "123" });
```

### `create(table, body)`

Insere registro com `ixcsoft: incluir`.

```ts
const result = await ixc.create("cliente", {
  razao: "Cliente Teste",
  tipo_pessoa: "F",
});
```

### `update(table, body)`

Atualiza registro com `ixcsoft: alterar`.

```ts
const result = await ixc.update("cliente", {
  id: "123",
  razao: "Cliente Atualizado",
});
```

### `delete(table, body)`

Remove registro com `ixcsoft: deletar`.

```ts
const result = await ixc.delete("cliente", { id: "123" });
```

## Observação

Os endpoints/tabelas e payloads dependem da documentação oficial do IXC Soft:
https://wikiapiprovedor.ixcsoft.com.br/#

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