@axionenterprise/data-sdk

SDK oficial Node.js para a API https://data.axionenterprise.cloud/.

Instalação

npm install @axionenterprise/data-sdk

Início rápido (ESM)

import { AxionData } from "@axionenterprise/data-sdk";

const client = new AxionData({
  apiKey: process.env.AXION_DATA_API_KEY
});

const health = await client.health();
console.log(health);

Início rápido (CommonJS)

const { AxionData } = require("@axionenterprise/data-sdk");

Configuração

• baseUrl: URL base da API. Padrão https://data.axionenterprise.cloud/api
• apiKey: token de autenticação
• timeoutMs: timeout por requisição em milissegundos. Padrão 30000
• userAgent: User-Agent customizado da integração

Métodos principais

Saúde e autenticação

• health()
• login(username, password)
• verifyToken()
• getSession()
• logout()
• clientStatus()

Consultas

• consultaNome(nome, limit?)
• consultaDocumento(consulta, modulo?)
modulo aceito: "cpf" | "cnpj" | "rg" (padrão: "cpf")
• consultaTelefone(telefone)
• consultaEmail(email)

const porNome = await client.consultaNome("Maria", 1);
const porCpf = await client.consultaDocumento("00641042060");
const porCnpj = await client.consultaDocumento("12345678000199", "cnpj");
const porTelefone = await client.consultaTelefone("5511999999999");
const porEmail = await client.consultaEmail("[email protected]");

Operações adicionais

• criarContatoPdv(payload)
• createPixPayment(payload)
• getPaymentStatus(paymentId)
• createClientToken(description, expiresAt?)
• listClientTokens()
• deleteClientToken(tokenId)

Métodos HTTP genéricos

• request(path, options)
• get(path, options?)
• post(path, body, options?)
• put(path, body, options?)
• patch(path, body, options?)
• delete(path, options?)

Tratamento de erros

import { AxionDataError } from "@axionenterprise/data-sdk";

try {
  await client.consultaDocumento("00000000000");
} catch (error) {
  if (error instanceof AxionDataError) {
    console.log(error.status, error.code, error.message, error.details);
  }
}