Quickstart

Este guia leva você do zero ao primeiro request autenticado contra a Simplafy Seguros API. Ao final, você terá uma API key emitida, terá chamado um endpoint produtivo e saberá onde aprofundar a integração.

A Simplafy Seguros API é construída em NestJS, expõe rotas REST e aceita dois esquemas de autenticação: JWT em cookies httpOnly (usado pelo frontend) e API key (recomendada para integrações server-to-server). Este quickstart foca no fluxo de API key.

Pré-requisitos

Antes de começar, confirme que você tem:

• Acesso a uma conta de usuário ativa na Simplafy Seguros (e-mail e senha válidos para login no painel).
• Um terminal com curl instalado, ou um runtime Node.js 20+ se preferir os exemplos em TypeScript.
• Conectividade com https://api-seguros.simplafy.com.br (sem bloqueio de firewall corporativo).
• Permissão para emitir API keys no seu workspace. Se você não vê o endpoint POST /api-keys retornar sucesso, fale com o administrador da sua organização.

Obter API key

API keys são emitidas via endpoint protegido por JWT. O fluxo tem dois passos: autenticar como usuário e criar a key.

curl -X POST https://api-seguros.simplafy.com.br/auth/login \
  -H "Content-Type: application/json" \
  -c cookies.txt \
  -d '{
    "email": "[email protected]",
    "password": "sua-senha"
  }'

curl -X POST https://api-seguros.simplafy.com.br/api-keys \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{
    "email": "[email protected]"
  }'

{
  "id": "uuid-da-key",
  "key": "sk_live_...",
  "user": { "id": "uuid", "email": "[email protected]" }
}

Primeira chamada

Com a API key em mãos, autentique requests enviando-a no header x-api-key. Como alternativa, a API também aceita o esquema Authorization: Bearer <key>.

O exemplo abaixo lista vendas via GET /api/sales, um endpoint coberto pelo guard JwtOrApiKeyGuard — ou seja, aceita tanto JWT quanto API key.

curl -X GET "https://api-seguros.simplafy.com.br/api/sales?page=1&limit=10" \
  -H "x-api-key: sk_live_..." \
  -H "Accept: application/json"

const API_BASE = "https://api-seguros.simplafy.com.br";
const API_KEY = process.env.SIMPLAFY_SEGUROS_API_KEY;

async function listSales() {
  const url = new URL("/api/sales", API_BASE);
  url.searchParams.set("page", "1");
  url.searchParams.set("limit", "10");

  const res = await fetch(url, {
    headers: {
      "x-api-key": API_KEY ?? "",
      Accept: "application/json",
    },
  });

  if (!res.ok) {
    throw new Error(`Request failed: ${res.status} ${res.statusText}`);
  }

  return res.json();
}

listSales().then(console.log).catch(console.error);

Status 200 OK confirma que a credencial está válida e o endpoint responde. Se receber 401 Unauthorized, revise:

• Header x-api-key foi enviado em todas as requisições?
• A key foi copiada por inteiro, sem espaços ou quebras de linha?
• O usuário associado à key ainda está ativo?

Próximos passos

Você fez seu primeiro request autenticado. A partir daqui:

Para reportar bugs ou pedir features na API, abra uma issue em github.com/Simplafy-tec/simplafy-seguros ou contate o time pelo canal interno de suporte.