---
title: 1.1. Primeiros Passos
url: https://docs.vehub.com.br/API/VeFlow%20-%20Cart%C3%A3o%20de%20cr%C3%A9dito/1.%20In%C3%ADcio/1.1.%20Primeiros%20Passos/
---
Nesta seção, apresentamos o conjunto de **APIs** que viabilizam o processo de **consulta da agenda de recebíveis** e **geração do contrato** de **antecipação** ou **garantia fiduciária**, por meio da plataforma **VeFlow**.

## 1.1.1 Acesso aos Serviços

Para obter acesso aos serviços, entre em contato com nosso time pelo e-mail:

📧 **[contato@vertrau.capital](mailto:contato@vertrau.capital)**

A liberação será realizada tanto para o ambiente de **Homologação (Sandbox)** quanto para o ambiente **Produtivo**.

Na liberação você recebe o `client_id`, o `client_secret`, o identificador do seu **grupo econômico** e o `idOperacao` que será usado nas solicitações de agenda.

## 1.1.2 Autenticação

Todas as requisições exigem os seguintes headers de autenticação:

| Header           | Tipo         | Descrição                             |
| ---------------- | ------------ | ------------------------------------- |
| `Authorization`  | Bearer Token | Token OAuth2 obtido via Keycloak      |
| `GrupoEconomico` | string       | Identificador do grupo econômico      |

!!! warning "O header `GrupoEconomico` é obrigatório em **todas** as requisições"
    Ele acompanha o token em qualquer chamada, inclusive nas consultas (`GET`). É esse header que define **em nome de qual grupo econômico** a requisição é executada, e ele determina quais agendas, carrinhos e contratos ficam visíveis. Requisições sem ele são recusadas.

### Obtenção do Token (OAuth2)

```bash
curl --location 'https://api.vehub.com.br/public/v1/auth/login' \
--header 'accept: */*' \
--header 'Accept-Language: pt-BR' \
--header 'Content-Type: application/json' \
--data '{
  "client_id": "seu-client-id",
  "client_secret": "seu-client-secret"
}'
```

| Campo           | Tipo   | Obrigatório | Descrição                                                                   |
| --------------- | ------ | ----------- | --------------------------------------------------------------------------- |
| client_id       | string | Sim         | Identificador da aplicação, entregue na liberação do acesso.                |
| client_secret   | string | Sim         | Segredo da aplicação. Mantenha-o no servidor; não o publique no cliente.    |

O token tem prazo de validade. Reaproveite o mesmo token enquanto ele for válido e solicite um novo antes de expirar — não gere um token por requisição.

### Uso do Token nas Chamadas da API

```bash
curl -X GET "https://api.veflow.com/public/api/v1.1/cartao/agendas?indicePagina=1&tamanhoDaPagina=20" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json"
```

## 1.1.3 Ambientes

Existem dois ambientes, com credenciais e dados independentes:

| Ambiente                  | Finalidade                                                                                                        |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Homologação (Sandbox)** | Desenvolvimento e testes da integração. Não gera operação real e não registra ônus junto às registradoras.        |
| **Produtivo**             | Operação real. As solicitações consultam as registradoras e os contratos gerados produzem efeito.                 |

A **autenticação** é feita no host do ambiente correspondente:

| Ambiente                  | Endpoint de autenticação                              |
| ------------------------- | ----------------------------------------------------- |
| Homologação (Sandbox)     | `https://dev.api.vehub.com.br/public/v1/auth/login`   |
| Produtivo                 | `https://api.vehub.com.br/public/v1/auth/login`      |

Já as chamadas da **API de cartão** têm sempre esta base:

```
https://api.veflow.com/public/api/v1.1/cartao
```

O host do VeFlow é próprio de cada ambiente e de cada grupo econômico — o valor exato de Homologação e de Produção é entregue junto com as credenciais, na liberação do acesso. Sempre valide o fluxo completo em Homologação antes de apontar sua integração para Produção.

## 1.1.4 Próximos Passos

* Headers obrigatórios, idempotência, paginação, códigos de resposta, formato de erro e janela de operação: [1.2. Convenções da API](1.2.%20Convenções%20da%20API.md).
* Conceitos do produto (UR, agenda, carrinho, contrato): [2.1. Conceitos](../2.%20Introdução/2.1.%20Conceitos.md).
* Primeira chamada do fluxo, a solicitação da agenda: [4.1. Solicitar agenda](../4.%20Agenda%20de%20recebíveis/v1.1/4.1.%20Solicitar%20agenda.md).
* Quem já integra a v1 e vai migrar: [9. Mudanças e Impacto nas Integrações](../9.%20Mudanças%20e%20Impacto%20nas%20Integrações.md).