Ecomiles EcomilesEcomilhas Developers
API PLATFORM · IN PLANNING · EARLY ACCESS OPEN PLATAFORMA DE API · EM PLANEJAMENTO · EARLY ACCESS ABERTO

Build decarbonization into your product Construa descarbonização dentro do seu produto

One API for trip capture, ecomiles balance, Mastercard wallet and auditable CO2e impact — ready for EV apps, delivery fleets, benefits platforms, sports clubs and ESG software. Uma API para captura de trajetos, saldo de ecomilhas, wallet Mastercard e impacto de CO2e auditável — pronta para apps de EV, frotas de delivery, plataformas de benefícios, clubes e softwares ESG.

# Register a verified trip
POST /v1/trips
{
  "user_id": "usr_8a1b2c",
  "modal": "EV_CAR",
  "distance_km": 18.4
}

# → 201 Created
{
  "ecomiles_earned": 5.52,
  "co2e_avoided_kg": 2.87
}
Platform modulesMódulos da plataforma

Five modules, one integrationCinco módulos, uma integração

Pick what your product needs. Everything shares the same auth, idempotency and webhook layer. Use o que seu produto precisa. Tudo compartilha a mesma camada de autenticação, idempotência e webhooks.

🪙

Balance & Wallet

Balance, statement, partner credits and Mastercard push provisioning to Apple Pay / Google Wallet (MDES).Saldo, extrato, créditos do parceiro e push provisioning do cartão Mastercard para Apple Pay / Google Wallet (MDES).

GET /users/{id}/balancePOST /wallet/provisioning-token
🛰️

Trips

Automatic trip capture from vehicle telemetry, delivery platforms or our SDK — with ecomiles and avoided CO2e per modal.Captura automática de trajetos via telemetria veicular, plataformas de entrega ou nosso SDK — com ecomilhas e CO2e evitado por modal.

POST /tripsPOST /trips:bulk
📊

Impact & Inventory

Consolidated organizational impact and GHG Protocol inventory — exports ready for WayCarbon, Clima and audit trails.Impacto consolidado por organização e inventário GHG Protocol — exports prontos para WayCarbon, Clima e trilhas de auditoria.

GET /organizations/{id}/impactPOST /inventories
🧩

Widget & SDK

White-label embeddable widget (web) and Flutter / React Native SDKs with background trip detection. Your colors, our engine.Widget white-label embarcável (web) e SDKs Flutter / React Native com detecção de trajetos em background. Suas cores, nosso motor.

POST /widget/sessions
🔔

Webhooks

Real-time events with HMAC signatures and 24h retries: trips, balances, redemptions, inventories, campaign goals.Eventos em tempo real com assinatura HMAC e retry por 24h: trajetos, saldos, resgates, inventários, metas de campanha.

trip.processedinventory.completed
Use casesCasos de uso

Built for your verticalFeito para a sua vertical

The same platform powers five very different products. Find yours. A mesma plataforma alimenta cinco produtos bem diferentes. Encontre o seu.

🚗

EV automakers & vehicle appsMontadoras & apps de veículos elétricos

VW · BYD · Mercedes-Benz

Turn telemetry into a green loyalty program. Every electric kilometer earns ecomiles the driver redeems on a Mastercard — and the automaker gets fleet-level avoided CO2e for ESG reporting.Transforme telemetria em programa de fidelidade verde. Cada km elétrico rende ecomilhas que o motorista resgata no Mastercard — e a montadora obtém o CO2e evitado da frota para o relatório ESG.

Flow: driver consents via OAuth → backend posts trips (POST /trips:bulk, modal EV_CAR) → widget shows balance in-app → redemption on the Ecomiles Mastercard.Fluxo: motorista consente via OAuth → backend envia trajetos (POST /trips:bulk, modal EV_CAR) → widget exibe saldo no app → resgate no cartão Ecomilhas Mastercard.
🛵

Logistics & delivery operatorsOperadores de logística & delivery

iFood · 99Food · carriers

Reward couriers on bikes, e-bikes and electric motorcycles per validated delivery — and pull auditable Scope 3 avoided emissions for the fleet, per order.Recompense entregadores de bike, e-bike e moto elétrica por entrega validada — e obtenha emissões evitadas auditáveis de Escopo 3 da frota, por pedido.

Flow: link couriers (POST /organizations/{id}/members) → send delivery trips → couriers earn extra income → GET /organizations/{id}/impact feeds the sustainability report.Fluxo: vincule entregadores (POST /organizations/{id}/members) → envie trajetos de entrega → entregadores ganham renda extra → GET /organizations/{id}/impact alimenta o relatório de sustentabilidade.
💳

Benefits platformsPlataformas de benefícios

Pluxee · Edenred · Swile

Ship a "green benefit" on your shelf: employees earn for sustainable commuting, HR gets Scope 3 category 7 data ready for CSRD / IFRS S2 — inside your existing card ecosystem.Lance o "benefício verde" na sua prateleira: colaboradores ganham por commuting sustentável, o RH recebe dados de Escopo 3 categoria 7 prontos para CSRD / IFRS S2 — dentro do seu ecossistema de cartões.

Flow: company activates the benefit → SDK captures commutes (or POST /companies/{id}/bulk-credits) → balance in your app → commuting impact report per site/cost center.Fluxo: empresa ativa o benefício → SDK captura trajetos casa-trabalho (ou POST /companies/{id}/bulk-credits) → saldo no seu app → relatório de impacto do commuting por unidade/centro de custo.
🏟️

Clubs, entertainment & mediaClubes, entretenimento & mídia

Atlético de Madrid · Palmeiras · Globo

Fans earn multiplied ecomiles for low-carbon trips to the stadium; the club consolidates fan-mobility CO2e and reports it automatically to WayCarbon, Clima or its inventory spreadsheet.Torcedores ganham ecomilhas multiplicadas por trajetos de baixo carbono ao estádio; o clube consolida o CO2e da mobilidade da torcida e reporta automaticamente para WayCarbon, Clima ou sua planilha de inventário.

Flow: branded widget in the club app → matchday campaigns (POST /companies/{id}/campaigns, geofenced multipliers) → redemption in experiences/merch → GET /organizations/{id}/impact/export.Fluxo: widget com a marca no app do clube → campanhas de matchday (POST /companies/{id}/campaigns, multiplicadores com geofence) → resgate em experiências/produtos → GET /organizations/{id}/impact/export.
📈

ESG & inventory platformsPlataformas ESG & de inventário

WayCarbon · Clima · ESG consultancies

Consume primary, MRV-traceable mobility data straight into your client's inventory — every reported tonne decomposes into individual verified trips. Or push activity data into Ecomiles with the Inventory API.Consuma dados primários de mobilidade, rastreáveis em MRV, direto no inventário do seu cliente — cada tonelada reportada se decompõe em trajetos individuais verificados. Ou envie dados de atividade para a Ecomilhas com a API de Inventário.

Flow: client consents → GET /organizations/{id}/impact/export?format=ghg (or webhook push) → data lands in the inventory, no spreadsheets.Fluxo: cliente consente → GET /organizations/{id}/impact/export?format=ghg (ou push via webhook) → dado cai no inventário, sem planilhas.
How to integrateComo integrar

Three ways in — with or without a tech teamTrês caminhos — com ou sem time técnico

In plain words: an API is a secure bridge that lets your systems and ours exchange data automatically. But you don't need one to start — pick the path that fits your team today and upgrade later. Em palavras simples: uma API é uma ponte segura que permite que os seus sistemas e os nossos troquem dados automaticamente. Mas você não precisa dela para começar — escolha o caminho que cabe no seu time hoje e evolua depois.

🚀

1 · Program without IT1 · Programa sem TI

For HR, benefits and sustainability teams.Para times de RH, benefícios e sustentabilidade. Your people use the Ecomiles app, you follow results in the business dashboard. No integration, live in weeks.Seus colaboradores usam o app Ecomilhas e você acompanha os resultados no painel business. Sem integração, no ar em semanas.

Talk to our team →Falar com nosso time →

🧩

2 · Embed our widget2 · Embarque nosso widget

For product teams with an app.Para times de produto com app próprio. Drop the white-label widget or mobile SDK into your app: balance, trips and redemption appear with your brand — we do the heavy lifting.Coloque o widget white-label ou o SDK mobile no seu app: saldo, trajetos e resgate aparecem com a sua marca — nós fazemos o trabalho pesado.

Request a demo →Pedir uma demo →

🔧

3 · Full API3 · API completa

For engineering teams.Para times de engenharia. REST endpoints, webhooks and sandbox to build your own experience: send trips, credit ecomiles, pull auditable CO2e for ESG reporting.Endpoints REST, webhooks e sandbox para construir sua própria experiência: envie trajetos, credite ecomilhas, extraia CO2e auditável para o reporte ESG.

Get API access →Pedir acesso à API →

What the journey looks likeComo é a jornada
1. Conversation — tell us your goal (engagement, Scope 3 reporting, green benefit) · contato@ecomiles.app
2. Sandbox — technical teams get test keys and synthetic data; no production risk
3. Pilot — a real group, real trips, results measured together
4. Production — rollout with support, dashboards and auditable reporting
1. Conversa — conte seu objetivo (engajamento, reporte de Escopo 3, benefício verde) · contato@ecomiles.app
2. Sandbox — times técnicos recebem chaves de teste e dados sintéticos; zero risco em produção
3. Piloto — um grupo real, trajetos reais, resultados medidos juntos
4. Produção — rollout com suporte, dashboards e reporte auditável
QuickstartComece rápido

Three calls to your first credited tripTrês chamadas até o primeiro trajeto creditado

Sandbox with synthetic data before go-live. Target integration time: under one week. Sandbox com dados sintéticos antes do go-live. Meta de integração: menos de uma semana.

# Every sustainable kilometer becomes value
curl -X POST https://sandbox.api.ecomilhas.com/v1/trips \
  -H "X-Api-Key: $ECOMILES_KEY" \
  -H "Idempotency-Key: trip-0001" \
  -d '{
    "external_trip_id": "APP-TRIP-0001",
    "user_id": "usr_8a1b2c",
    "modal": "BICYCLE",
    "distance_km": 6.2,
    "started_at": "2026-07-30T08:02:00Z",
    "ended_at": "2026-07-30T08:31:00Z",
    "source": "SDK_AUTO"
  }'

# 201 → {"ecomiles_earned": 1.86, "co2e_avoided_kg": 0.97, "status": "PROCESSED"}
# Show it in your app
curl https://sandbox.api.ecomilhas.com/v1/users/usr_8a1b2c/balance \
  -H "X-Api-Key: $ECOMILES_KEY"

# 200 →
{
  "balance": 1250.5,
  "lifetime_earned": 4890.0,
  "co2e_avoided_kg_lifetime": 312.4
}
# GHG Protocol-structured export for ESG platforms
curl "https://sandbox.api.ecomilhas.com/v1/organizations/org_123/impact/export?format=ghg&period_start=2026-01-01&period_end=2026-06-30" \
  -H "X-Api-Key: $ECOMILES_KEY"

# 200 → scope / category / tCO2e entries, MRV-traceable to individual trips
API referenceReferência da API

Endpoints at a glanceEndpoints em resumo

REST, path-versioned (/v1), ISO 8601 dates, cursor pagination, Idempotency-Key support. Full schema in the OpenAPI spec. REST, versionamento por path (/v1), datas ISO 8601, paginação por cursor, suporte a Idempotency-Key. Schema completo na spec OpenAPI.

MethodEndpointDescriptionDescrição
GET/v1/users/{id}/balanceUser balance + lifetime impactSaldo do usuário + impacto acumulado
GET/v1/users/{id}/transactionsStatement with filtersExtrato com filtros
POST/v1/users/{id}/creditsPartner-issued creditsCréditos emitidos pelo parceiro
POST/v1/wallet/provisioning-tokenMastercard push provisioning (MDES)Push provisioning Mastercard (MDES)
POST/v1/trips · /v1/trips:bulkRegister trips (single / up to 500)Registrar trajetos (unitário / até 500)
GET/v1/organizations/{id}/impactConsolidated impact by period/modalImpacto consolidado por período/modal
GET/v1/organizations/{id}/impact/exportGHG / CSV / JSON export for ESG platformsExport GHG / CSV / JSON para plataformas ESG
POST/v1/companies/{id}/campaignsCampaigns, multipliers, geofencesCampanhas, multiplicadores, geofences
POST/v1/companies/{id}/bulk-creditsBatch distribution (up to 1,000)Distribuição em lote (até 1.000)
POST/v1/widget/sessionsShort-lived token to embed the widgetToken de curta duração para embarcar o widget
POST/v1/inventories + items, status, results+ itens, status, resultadosCO2e inventory lifecycle (GHG Protocol)Ciclo do inventário CO2e (GHG Protocol)

Supported modals:Modais suportados: WALK BICYCLE E_BIKE SCOOTER EV_MOTORCYCLE EV_CAR CARPOOL BUS RAIL METRO

Webhooks

React in real timeReaja em tempo real

HMAC-SHA256 signed (X-Ecomilhas-Signature), exponential-backoff retries for up to 24h. Assinados com HMAC-SHA256 (X-Ecomilhas-Signature), retry com backoff exponencial por até 24h.

trip.processedbalance.updatedreward.redeemedinventory.completedcampaign.endedgoal.achieved
Security & complianceSegurança & conformidade

Boring where it mattersSério onde importa

  • OAuth 2.0client credentials for servers; "Connect with Ecomiles" authorization-code flow with granular scopes for end-user consent.client credentials para servidores; fluxo "Conectar com Ecomilhas" (authorization code) com escopos granulares para consentimento do usuário.
  • LGPD / GDPRdata minimization, deletion propagation, organizations only ever see aggregates — never raw location.minimização de dados, propagação de exclusão, organizações só veem agregados — nunca localização bruta.
  • Mastercard MDEScard provisioning through network standards; the PAN is never exposed to partners.provisioning do cartão pelos padrões da bandeira; o PAN nunca é exposto a parceiros.
  • GHG Protocol + MRVversioned emission factors per modal/region; every tCO2e traceable to its trips. Methodology with limited assurance by KPMG.fatores de emissão versionados por modal/região; cada tCO2e rastreável até seus trajetos. Metodologia com asseguração limitada KPMG.
  • Anti-fraudspeed-vs-modal checks, spatio-temporal dedup, idempotency by external id.validação velocidade × modal, deduplicação espaço-temporal, idempotência por id externo.
  • Rate limiting & sandboxtiered quotas, full test environment before production keys.cotas por tier, ambiente de testes completo antes das chaves de produção.
  • Hardened by defaultTLS everywhere, strict security headers (CSP, X-Frame-Options, nosniff) on this portal, webhook HMAC signatures and secret rotation.TLS em tudo, security headers estritos (CSP, X-Frame-Options, nosniff) neste portal, assinaturas HMAC nos webhooks e rotação de segredos.
  • Responsible disclosurefound a vulnerability? See security.txt or write to contato@ecomiles.app.encontrou uma vulnerabilidade? Veja o security.txt ou escreva para contato@ecomiles.app.
Roadmap

Where we areOnde estamos

The platform is in technical planning — no endpoint is live in production yet. Design partners shape the final scope with us. A plataforma está em planejamento técnico — nenhum endpoint está em produção ainda. Design partners definem o escopo final conosco.

In developmentEm desenvolvimento

Phase 1 — InventoryFase 1 — Inventário

CO2e Inventory API (4 MVP endpoints) + export for ESG platforms.API de Inventário CO2e (4 endpoints MVP) + export para plataformas ESG.

Technical planningPlanejamento técnico

Phase 2 — Trips & BalanceFase 2 — Trajetos & Saldo

Trips API, Balance API and the webhook layer.Trips API, Balance API e a camada de webhooks.

Product visionVisão de produto

Phase 3 — Widget & WalletFase 3 — Widget & Wallet

White-label widget/SDK and Mastercard push provisioning.Widget/SDK white-label e push provisioning Mastercard.

Integrate early. Shape the API.Integre cedo. Molde a API.

Tell us your format, source systems and volumes — early partners get direct access to the engineering team and priority in Phase 2.Conte seu formato, sistemas de origem e volumes — parceiros early têm acesso direto ao time de engenharia e prioridade na Fase 2.