Comece por aqui

A API do Crédito Semanal é uma interface HTTP/JSON que expõe, de forma segura, duas capacidades da plataforma para o seu time de tecnologia:

• Captar leads — envie para o Crédito Semanal cada interessado que preenche um

formulário no seu site ou nas suas landing pages, sem depender do formulário padrão.

• Ler a sua operação — consulte, de forma programática, os leads que a sua

empresa recebeu e os dados de configuração da sua conta.

É uma API REST: recursos são acessados por URLs, os verbos HTTP indicam a ação (GET para ler, POST para criar) e todo corpo trafega em JSON.

Um exemplo em 30 segundos

Enviar um lead é uma única requisição:

curl -X POST https://server.creditosemanal.com.br/public/leads \
  -H "x-api-key: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Maria Silva", "email": "maria@exemplo.com", "phone": "(32) 99999-0000" }'

Resposta:

{ "result": { "id": 128 }, "meta": { "code": 201 } }

O id retornado é o identificador do lead dentro do Crédito Semanal.

Base URL

Todos os endpoints partem de uma única origem, e os recursos públicos ficam sob o prefixo /public:

https://server.creditosemanal.com.br

Use sempre HTTPS. Requisições em HTTP são recusadas.

O envelope de resposta

Toda resposta bem-sucedida segue o mesmo formato, o que torna o consumo previsível: os dados vêm em result e os metadados em meta.

{
  "result": { "id": 128 },
  "meta": { "code": 201 }
}

Em listas, result é um array e meta traz a paginação:

{
  "result": [ { "id": 128, "name": "Maria Silva" } ],
  "meta": { "code": 200, "total": 42, "page": 1, "per_page": 20, "pages": 3 }
}

Campo em meta	Descrição
code	Código HTTP repetido no corpo, por conveniência
total	Total de itens que casam com o filtro
page	Página atual
per_page	Itens por página
pages	Total de páginas

Próximos passos

1. Autenticação — gere e use a sua x-api-key. 2. Leads — envie e liste leads. 3. Empresa — leia os dados e a landing da sua conta.