Skip to navigation
Primeiros passos

Conectar um programa

Chame o Gateway a partir do seu sistema, com um SDK ou com HTTP puro.
View as Markdown

Um programa é um sistema da sua organização que usa o Basement por código: uma integração, um script, um serviço de back-end. Ele usa as mesmas ferramentas que um agente, com uma chave própria, e assim o registro de atividade mostra o sistema pelo nome dele.

1

Crie uma chave para o programa

No Basement, abra Agentes e clique em Conectar agente. Selecione Programa, dê um nome ao sistema (por exemplo, “Sistema de faturamento”) e selecione o nível de acesso dele.

O Basement mostra a chave uma única vez. Copie a chave agora e guarde em um cofre de segredos ou em uma variável de ambiente. Não coloque a chave no código-fonte.

2

Instale o SDK

npm install @basementai/gateway
3

Faça a primeira chamada

import { BasementGatewayClient } from "@basementai/gateway";
const basement = new BasementGatewayClient({
  apiKey: process.env.BASEMENT_API_KEY,
});
const me = await basement.whoami();
console.log(me.orgName);
const { docs } = await basement.docs.list();
const doc = await basement.docs.read({ docId: docs[0].id });
console.log(doc.title, doc.bodyMarkdown);

Os dois SDKs leem a chave da variável de ambiente BASEMENT_API_KEY quando você não informa uma.

O que acontece depois

  • O programa só consegue chamar o que o nível de acesso dele permite. Uma chamada fora disso responde 403. Veja Erros e limites.
  • Cada chamada aparece em Agentes, Atividade, marcada como programa, com o SDK e a versão dele. Veja Registro de atividade.
  • A lista completa de operações está na Referência da API.