IonLuz

IonLuz API

IonLuz API as documented publicly: 9 operations. Contract generated from the documentation by API Evangelist (2026-11-12); not the provider's own document.

GitHub OpenAPI

Operations 9

GET /api/v1/coverage GET /api/v1/coverage #
POST /api/v1/leads POST /api/v1/leads #
POST /api/v1/quote POST /api/v1/quote #
POST /hooks/ionluz Webhooks de saída #
GET /v1/coverage Limites e headers #
POST /v1/leads POST /v1/leads recebe o lead do formulário do anúncio pela sua integração, com o consentimento da pessoa, e grava o orçamento automático. #
GET /v1/proposals Limites e headers #
GET /v1/proposals/{id} Limites e headers #
POST /v1/quote quote_solar receives the same fields as POST /v1/quote. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ionluz-com-br/openapi/_ae-authored/ionluz-com-br-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ionluz-com-br/json-schema/ionluz-com-br-post-api-v1-leads-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ionluz-com-br/json-schema/ionluz-com-br-post-hooks-ionluz-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ionluz-com-br/json-schema/ionluz-com-br-post-hooks-ionluz-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ionluz-com-br/json-schema/ionluz-com-br-post-v1-leads-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ionluz-com-br/json-schema/ionluz-com-br-post-api-v1-quote-request-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/ionluz-com-br/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ionluz-com-br:ionluz-com-br-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ionluz-com-br-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: IonLuz API
  version: '2026-11-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-12: 9 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; IonLuz has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 6
    pages-with-code: 4
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://app.ionluz.com.br/docs/api
  - https://app.ionluz.com.br/docs/api/mcp
  - https://app.ionluz.com.br/docs/api/leads
  - https://app.ionluz.com.br/docs/api/cotacao
  - https://app.ionluz.com.br/docs/api/limites
  - https://app.ionluz.com.br/docs/api/mudancas
  - https://app.ionluz.com.br/docs/api/webhooks
  - https://app.ionluz.com.br/docs/api/cobertura
paths:
  /api/v1/coverage:
    get:
      operationId: get_api_v1_coverage
      tags:
      - Api
      summary: GET /api/v1/coverage
      x-source: https://app.ionluz.com.br/docs/api/cobertura
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://app.ionluz.com.br/api/v1/coverage -H \"Authorization: Bearer ilz_sua_chave\" Copiar Conta nova, ainda sem nenhuma\
          \ faixa própria: {\n \"ok\": true,\n \"modo\": \"linha\",\n \"ativa\": true,\n \"cobertas\": 0,\n \"total\": 18,\n \"completa\": false,\n\
          \ \"naoAtendo\": 0,\n \"resumo\": \"0 de 18 faixas com kit seu; o resto usa o catálogo padrão ionluz.\",\n \"tetoKw\": 75,\n \"unidadeFaixas\"\
          : \"kw-saida-inversor\",\n \"fases\": "
  /api/v1/leads:
    post:
      operationId: post_api_v1_leads
      tags:
      - Api
      summary: POST /api/v1/leads
      x-source: https://app.ionluz.com.br/docs/api/leads
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1LeadsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://app.ionluz.com.br/api/v1/leads  -H "Authorization: Bearer ilz_sua_chave"  -H "Idempotency-Key: 1259783460127734"  -H
          "Content-Type: application/json"  -d ''{ "nome": "Maria Exemplo", "telefone": "(15) 99999-0000", "email": "cliente@exemplo.com.br",
          "cidade": "Sorocaba", "uf": "SP", "fases": "bi", "valorContaBrl": 614, "origem": "meta-formulario", "campanha": { "utm_source": "me'
  /api/v1/quote:
    post:
      operationId: post_api_v1_quote
      tags:
      - Api
      summary: POST /api/v1/quote
      x-source: https://app.ionluz.com.br/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1QuoteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.ionluz.com.br/api/v1/quote  -H \"Authorization: Bearer ilz_test_sua_chave_de_teste\"  -H \"Content-Type:\
          \ application/json\"  -d '{ \"consumoKwhMes\": 600, \"uf\": \"SP\", \"fases\": \"bi\" }' Copiar A resposta identifica o modo, no corpo\
          \ e no cabeçalho X-Ionluz-Sandbox: 1 : {\n \"ok\": true,\n \"orcamento\": {\n \"potenciaKwp\": 5.72,\n \"valorFinal\": 14296.8,\n \"\
          paybackAnos\": 2.208259927284166,\n \""
  /hooks/ionluz:
    post:
      operationId: post_hooks_ionluz
      tags:
      - Hooks
      summary: Webhooks de saída
      x-source: https://app.ionluz.com.br/docs/api/webhooks
      parameters:
      - name: X-Ionluz-Event
        in: header
        required: true
        schema:
          type: string
        description: 'Tipo do evento enviado (ex.: lead.criado, proposta.aberta, proposta.aceita, ping).'
      - name: X-Ionluz-Delivery
        in: header
        required: true
        schema:
          type: string
        description: 'Identificador único da entrega (ex.: evt_3f1a9c72b0d84e5f16).'
      - name: X-Ionluz-Signature
        in: header
        required: true
        schema:
          type: string
        description: Assinatura HMAC SHA‑256 no formato t=<unix>,v1=<hex>.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHooksIonluzRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHooksIonluzResponse'
      x-evidence:
        kind: documentation
  /v1/coverage:
    get:
      operationId: get_v1_coverage
      tags:
      - Coverage
      summary: Limites e headers
      x-source: https://app.ionluz.com.br/docs/api/limites
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/leads:
    post:
      operationId: post_v1_leads
      tags:
      - Leads
      summary: POST /v1/leads recebe o lead do formulário do anúncio pela sua integração, com o consentimento da pessoa, e grava o orçamento automático.
      description: 'A Idempotency-Key desta rota vale por 30 dias. Erros novos: contato-obrigatorio, consentimento-invalido e origem-invalida.'
      x-source: https://app.ionluz.com.br/docs/api/mudancas
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1LeadsResponse'
      x-evidence:
        kind: documentation
  /v1/proposals:
    get:
      operationId: get_v1_proposals
      tags:
      - Proposals
      summary: Limites e headers
      x-source: https://app.ionluz.com.br/docs/api/limites
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/proposals/{id}:
    get:
      operationId: get_v1_proposals_id
      tags:
      - Proposals
      summary: Limites e headers
      x-source: https://app.ionluz.com.br/docs/api/limites
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/quote:
    post:
      operationId: post_v1_quote
      tags:
      - Quote
      summary: quote_solar receives the same fields as POST /v1/quote.
      description: 'Recebe os mesmos campos de POST /v1/quote, simulando a cotação solar. Por padrão só simula; passe persist: true para gravar
        a proposta e receber os links. Ao gravar, consent: true é obrigatório.'
      x-source: https://app.ionluz.com.br/docs/api/mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1LeadsRequest:
      type: object
      properties:
        nome:
          type: string
        telefone:
          type: string
        email:
          type: string
        cidade:
          type: string
        uf:
          type: string
        fases:
          type: string
        valorContaBrl:
          type: integer
        origem:
          type: string
        campanha:
          type: object
          properties:
            utm_source:
              type: string
            utm_medium:
              type: string
            utm_campaign:
              type: string
            utm_content:
              type: string
        consentimento:
          type: object
          properties:
            texto:
              type: string
            data:
              type: string
              format: date-time
            fonte:
              type: string
    PostApiV1QuoteRequest:
      type: object
      properties:
        consumoKwhMes:
          type: integer
        uf:
          type: string
        fases:
          type: string
    PostHooksIonluzRequest:
      type: object
      properties:
        id:
          type: string
          description: Id do evento.
        evento:
          type: string
          description: 'Nome do evento (ex.: lead.criado).'
        criadoEm:
          type: string
          description: Timestamp ISO 8601 da criação do evento.
        data:
          type: object
          description: Payload específico do evento.
      required:
      - id
      - evento
      - criadoEm
      - data
    PostHooksIonluzResponse:
      type: object
      properties:
        '200':
          type: string
          description: Entrega aceita; responder antes de processar o corpo.
        '401':
          type: string
          description: Assinatura inválida ou timestamp fora do limite de 5 minutos.
    PostV1LeadsResponse:
      type: object
      properties:
        proposalId:
          type: string
        pdfUrl:
          type: string
        propostaUrl:
          type: string
        aviso:
          type: string
        idempotent:
          type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Coverage
- name: Hooks
- name: Leads
- name: Proposals
- name: Quote