@hubexpresso/sdk

📦 ExpressoAPI JS SDK

SDK oficial para integração com a Expresso API usando JavaScript ou TypeScript.

Requisições simples, integração rápida, autenticação com apenas uma chave.

---

🚀 Instalação

Use o gerenciador de pacotes da sua escolha:

via npm

npm i @hubexpresso/sdk

via yarn

yarn add @hubexpresso/sdk

---

✨ Primeiros passos

1. Importe a SDK no seu projeto

const { startAPI } = require("@hubexpresso/sdk");

ou

import { startAPI } from '@hubexpresso/sdk'

---

2. Inicialize a API com sua chave

const api = startAPI("12345-XXXXX-XXXXX");

A chave de API pode ser gerada no Portal do Desenvolvedor.

---

📡 Endpoints disponíveis

🔹 Você pode ver todos os endpoints disponíveis na documentação oficial

---

🔐 Autenticação

A autenticação é feita via header Authorization com sua chave de API:

Usando a SDK, esse passo já está embutido para você 😉

---

⬆️ Atualizar a SDK

Execute o comando abaixo para garantir a versão mais recente:

via npm

npm update @hubexpresso/sdk

via yarn

yarn upgrade @hubexpresso/sdk

---

💡 Exemplos

Listar usuário e verificar se está cadastrado

import { startAPI } from "@hubexpresso/sdk";

const api = startAPI("12345-XXXXX-XXXXX");

try {
  const user = await api.getUserById("user_2v123456790");
  if (user) {
    console.log("Usuário encontrado:", user.username);
  }
} catch (err) {
  console.error("Erro ao buscar usuário:", err);
}