Pular para o conteúdo principal

Guia de Início Rápido

Bem-vindo à documentação da API CorpX. Este guia vai ajudá-lo a realizar sua primeira integração e entender os conceitos básicos da nossa plataforma.

1. Obtendo Credenciais​

Para começar a integrar, você precisará de credenciais de acesso. Entre em contato com nossa equipe de suporte para receber:

  • Client ID
  • Client Secret
  • X-Tenant-Id (Identificador do seu Tenant)

2. Autenticação​

Nossa API utiliza OAuth2 com o fluxo client_credentials. Você deve solicitar um access token para realizar chamadas à API.

Endpoints​

AmbienteToken endpointAPI base
Verde (atual)https://auth.api.corpx.com/oauth2/tokenhttps://tenant.api.corpx.com
Azul (legado)https://auth.corpxapi.com/oauth2/tokenhttps://api.corpxapi.com

Exemplo de Requisição de Token (Bash/cURL)​

curl -X POST "https://auth.api.corpx.com/oauth2/token" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -u "$CLIENT_ID:$CLIENT_SECRET" \
     -d "grant_type=client_credentials&scope=api2/read+api2/write"

A resposta inclui um access_token válido por 1 hora. Quando expirar, chame o mesmo endpoint para obter um novo. Cache o token no seu lado até expires_in - 60s para evitar requests desnecessários.

3. Realizando Sua Primeira Chamada​

Com o access token em mãos, você pode consultar o saldo de uma conta, por exemplo.

curl -X GET "https://tenant.api.corpx.com/v1/accounts/123456/balance" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "X-Tenant-Id: YOUR_TENANT_ID"

4. Próximos Passos​

  • Explore o Guia do Integrador para detalhes sobre headers obrigatórios e idempotência.
  • Consulte a Referência da API para ver todos os endpoints disponíveis.
  • Confira o guia de Webhooks para receber notificações em tempo real.

Precisa de ajuda? Entre em contato pelo seu canal Slack privado (solicite acesso durante o onboarding) ou envie um e-mail para support@corpxapi.com.