Início rápido

Para começar, você precisa da chave de API de dev e da URL do seu webhook já cadastrada. As duas saem do onboarding com o time de integrações.

Aponte para o ambiente de dev

Ambiente	Base da API	Para que serve
Dev	`https://orchestrator-partner.dev.wincred.digital/partners/v1`	Ambiente de testes do parceiro. Use a chave de dev e dados sintéticos
Produção	Enviada por e-mail na ativação	Indicações de clientes reais. O host não é publicado neste site

Nos exemplos deste site, a base da API está na variável WINCRED_API_URL:

export WINCRED_API_URL="https://orchestrator-partner.dev.wincred.digital/partners/v1"

Valide a chave: GET /ping

curl "$WINCRED_API_URL/ping" \
  --header "Authorization: Bearer <chave do parceiro>"

A resposta traz o seu identificador e os seus hubs, com a faixa de valor e prazo de cada um. Anote o code do hub padrão.

Teste o webhook: POST /webhooks/test

curl --request POST "$WINCRED_API_URL/webhooks/test" \
  --header "Authorization: Bearer <chave do parceiro>"

A Wincred envia um evento ping assinado para a sua URL e devolve o resultado da entrega. O esperado é "delivered": true.

Indique um cliente: POST /referrals

curl --request POST "$WINCRED_API_URL/referrals" \
  --header "Authorization: Bearer <chave do parceiro>" \
  --header "Content-Type: application/json" \
  --data '{ "customer": { "cpf": "<CPF de teste>", "name": "Cliente Sintético" } }'

A resposta traz o process_external_id e o url da jornada do cliente. Persista o process_external_id: ele é a chave da consulta e de todo webhook daquela indicação.

O passo a passo completo, com as respostas esperadas e o que fazer em cada erro, está em Testando em dev.

Introdução

Guia de integração

Referência da API

Eventos