Pular para o conteúdo
API de Integração da Xegora v1

Emita cartões-presente e eSIMs em uma só chamada

Um catálogo para todas as famílias de produtos. Um pedido é precificado no momento em que você o faz e nunca acima do teto que você definir, é idempotente em relação à sua carteira pré-paga, e os webhooks são assinados — então as novas tentativas são seguras e o dia do lançamento passa sem sustos.

As chaves de API são emitidas e gerenciadas no painel do lojista depois que seu espaço de trabalho é aprovado.

O ciclo de vida

Como flui um pedido

Um ciclo curto — três chamadas e um webhook assinado — e é o mesmo ciclo para todas as famílias de produtos.

  1. Encontre um produto

    GET /products

    Navegue por um único catálogo de cartões-presente, planos de eSIM e recargas por categoria, país ou texto — ou atualize exatamente os produtos que você vende pelo id.

  2. Faça o pedido

    POST /orders

    Envie o item: ele é precificado e pedido em uma só chamada, nunca acima do teto que você definir. Repetições com a mesma chave retornam o mesmo pedido.

  3. Receba o webhook

    order.fulfilled

    Um evento assinado avisa você no momento em que a entrega é concluída. Sem loops de polling.

  4. Revelar o código

    POST /orders/{id}/fulfillment

    Obtenha códigos e PINs por um endpoint dedicado e auditado — nunca em cache, cada revelação contabilizada.

Início rápido

Sua linguagem, HTTPS puro

Uma API REST limpa e previsível — entra JSON, sai JSON, um cabeçalho X-Api-Key e nenhum SDK necessário. Encontre, peça, revele: seu primeiro pedido leva três chamadas.

create-order.ts
const BASE = "https://integration.xegora.com/api/v1";
const response = await fetch(`${BASE}/orders`, {
method: "POST",
headers: {
"X-Api-Key": process.env.XEGORA_API_KEY!,
"Content-Type": "application/json",
"Idempotency-Key": "order-10231",
},
body: JSON.stringify({
clientReference: "po-10231",
item: { productId, variantId, quantity: 1, currency: "USD" },
maximumTotal: 60.0, // the price your buyer saw
}),
});
const order = await response.json();
// 409 price_above_maximum carries quotedTotal — show the new price instead
console.log(order.status); // "reserved" — wait for "fulfilled", then reveal
  • Pedidos idempotentes
  • Webhooks assinados
  • Chaves de API com escopo
  • Carteira pré-paga
Referência da API

A API essencial, de ponta a ponta

Formatos reais de requisição e resposta — clique em qualquer linha. Saques, histórico de depósitos e imagens de produtos completam a API; a referência completa está em docs.xegora.com.

POST /api/v1/orders

Faça pedidos com sua carteira pré-paga: envie o item para precificar e pedir em uma só chamada (com um maximumTotal opcional) ou um quoteId. O cabeçalho Idempotency-Key é obrigatório — uma nova tentativa retorna o mesmo pedido. Escopo: orders.create.

Exemplo de resposta202 Accepted
{
  "id": "0198e000-1111-7abc-9def-222233334444",
  "clientReference": "po-10231",
  "status": "reserved",
  "total": 58.50,
  "currency": "USD",
  "lines": [
    { "productId": "0198d72d-99d6-75a6-9f12-971050ba7a5f", "variantId": "0198d72d-a15b-7cbf-…",
      "productName": "Everyday Digital Gift Card", "variantLabel": "50", "quantity": 1,
      "unitPrice": 58.50, "currency": "USD", "faceValue": 50, "faceCurrency": "EUR" }
  ],
  "createdAtUtc": "2026-09-05T12:01:02Z",
  "updatedAtUtc": "2026-09-05T12:01:02Z"
}

Todo o resto está em docs.xegora.com

A documentação completa para desenvolvedores — todos os endpoints com esquemas de requisição e resposta, verificação da assinatura de webhooks em três linguagens e a especificação OpenAPI 3.1 completa.

  • Primeiros passos
  • Autenticação
  • Pedidos e cotações
  • Webhooks
  • Entrada em produção
Feito para produção

A infraestrutura sem graça que você realmente quer

Tudo o que faz uma integração de emissão sobreviver a tráfego real — idempotência, assinaturas, credenciais com escopo e uma carteira que não gasta além do saldo.

Catálogo unificado

Cartões-presente, planos de eSIM e recargas de celular compartilham um único esquema, um único feed de preços e um único fluxo de pedidos. Integre uma vez e todo produto que a Xegora adicionar fica disponível para você automaticamente.

Pedidos idempotentes

Tanto a criação do pedido quanto a revelação da entrega aceitam um cabeçalho Idempotency-Key. Instabilidade de rede, timeout, loop agressivo de novas tentativas — repita a requisição quantas vezes quiser e existirá exatamente um pedido.

Webhooks assinados

order.processing, order.fulfilled, order.failed, order.refunded e wallet.credited são entregues via HTTPS com uma assinatura HMAC-SHA256 (X-Xegora-Signature), reenviados com garantia de pelo menos uma entrega e deduplicados por um X-Xegora-Event-Id estável.

Chaves com privilégio mínimo

Cada chave tem um conjunto explícito de escopos — leitura do catálogo, cotação, pedidos, leitura da carteira e escopos que movimentam dinheiro são todos separados —, além de uma lista de permissões CIDR e uma expiração opcionais. A revogação é imediata.

Carteira pré-paga

Os pedidos reservam valores do seu saldo pré-pago e os capturam na entrega; falhas liberam a reserva automaticamente. Abasteça o saldo on-chain em um endereço de depósito permanente e saque fundos não utilizados apenas para os seus próprios dados de pagamento cadastrados.

Catálogo feito para a seleção

Navegue por categoria, país ou texto, filtre por valores fixos ou personalizados e atualize os produtos que você vende pelo id em uma única chamada — com as instruções de resgate e os outros países da marca em cada produto, com preços na sua moeda de venda.

Preços

Preços de atacado, sem surpresas

A cotação é o preço. Todo o resto das suas condições comerciais é acordado quando seu espaço de trabalho de lojista é configurado.

  • Preços de atacado dos produtos na sua moeda de venda — o total da cotação é exatamente o que é debitado da sua carteira
  • Sem taxas ocultas por chamada; limite fixo de 120 requisições/minuto por espaço de trabalho
  • O plano do seu espaço de trabalho (configuração e condições) é acordado no cadastro do lojista
  • Saques de fundos não utilizados são cotados com transparência — taxa, valor líquido e data de pagamento informados antecipadamente

Pronto para emitir seu primeiro pedido?

Solicite um espaço de trabalho de lojista pela sua conta, seja aprovado e emita chaves de API com escopo no painel — a partir daí, seu primeiro pedido está a três chamadas de distância. A referência completa está em docs.xegora.com.