Compensa API - Guia de integração
Seja muito bem vindo(a) à API da Compensa!
Aqui, você poderá calcular a pegada de carbono de seus fretes de forma fácil e direcionada.
📃 Funcionalidades
- Criar um usuário na API
- Autenticar seu usuário
- Calcular a pegada de carbono, para fretes:
- Nacionais e internacionais
- Com modal terrestre, aéreo, marítimo ou desconhecido
- Fracionados e dedicados
- Com base em CEPs, endereços ou distância percorrida
💡 Guia de integração
O uso desta API é muito simples, e está divido em três passos.
Mas, antes disso, é preciso entender como funcionam os diferentes ambientes para seu uso.
0. Ambientes
A API da Compensa tem dois ambientes distintos:
- Sandbox (sandbox.api.compensa.eco) - ambiente para uso livre para desenvolvimento. Todos os resultados são mockados e não correspondem aos cálculos reais das emissões correspondentes.
- Produção (api.compensa.eco) - ambiente para realizar efetivamente os cálculos de emissões para cada frete.
Atenção!
O ambiente de produção possui um limite de cálculo de 10 emissões por mês. Para aumentar o limite de uso, entre em contato com a equipe Compensa pelo chat no site da Compensa.
1. Criação do usuário
Para poder utilizar nossa calculadora de pegada de carbono, você precisa criar um usuário na API. Para tal, basta seguir as intruções da página Criar usuário.
2. Autenticação do usuário
Com o seu usuário criado, basta autenticá-lo para poder usar a calculadora. O endpoint de autenticação retorna um token de acesso, que deve ser usado como header de Authentication para o cálculo.
Este token tem validade de 30 dias.
3. Calculadora
Com o seu usuário criado e autenticado, o uso da calculadora é permitido. Nossa calculadora aceita uma série de diferentes inputs, que podem ser vistos de maneira detalhada na página Calcular pegada de carbono.