(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"258577418","description":"(Required) Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-notifica.ccee.org.br/v1/notificacoes/endpoint","description":"API para consulta do endpoint cadastrado para recebimento das mensagens.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","name":"Abertura de Mercado","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","notificacoes","endpoint"],"host":["api-notifica","ccee","org","br"],"query":[],"variable":[]}},"response":[{"id":"21d04138-d2bf-4dcb-abe7-0b132b4a9a20","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Código do Agente","key":"codigoAgente","value":"258577418"},{"description":"(Required) Código do Perfil","key":"codigoPerfil","value":"258577418"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-notifica.ccee.org.br/v1/notificacoes/certificado","description":"Operação para obter o certificado para validação do token da CCEE.
\n","urlObject":{"protocol":"https","path":["v1","notificacoes","certificado"],"host":["api-notifica","ccee","org","br"],"query":[],"variable":[]}},"response":[{"id":"4dc41a8b-4f7a-472f-8458-6c461b758ee5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Código do Agente","key":"codigoAgente","value":"Foi elaborada uma estrutura para o recebimento das mensagens, que deverá ser implementada pelos agentes. Para o desenvolvimento da API de recebimento de mensagens, é necessária a implementação do contrato pré-definido no arquivo swagger.
\nUma vez implementada a interface de recebimento de mensagens, será necessário criar uma estrutura de segurança para certificar a autenticidade das mensagens. Esse processo consiste em realizar a chamada a uma API que retornará um certificado para validar o token enviado junto com a mensagem.
\nTipos de Notificações
\nConforme demonstrado na interface swagger, cada tipo de notificação possui um \"conteúdo\" específico em formato JSON. Abaixo estão os tipos de notificações disponíveis atualmente, acompanhados de uma breve contextualização e seu respectivo \"conteúdo\":
\nO tipo de notificação será informado no campo tipoEnvioNotificacao. Para cada tipo de notificação será enviado um payload no formato json no campo conteudo, que representa a descrição da mensagem.
\nExemplo de Client para Recebimento de Notificação
\nExemplo de client para as notificações do projeto da Abertura de Mercado. O código pode ser encontrado aqui.
\nUso
\n\n
Requisitos:
\n- \n
Java 8 ou superior
\n \nMaven 3
\n \n
Execução:
\nmvn spring-boot:run\n\nUma documentação da API exposta pode ser vista em http://localhost:8082/swagger-ui/index.html.
\nPadrão da requisição HTTP
\n\n
Os seguintes dados são enviados a cada requisição HTTP do webhook:
\n- \n
Método:
\n- \n
- POST \n
\nCabeçalhos HTTP:
\n- \n
user-agent: CCEE Webhook API
\n \ncontent-type: application/json
\n \nauthorization: Bearer token
\n \n
\nDados:
\n- \n
- Conteúdo no formato JSON (ver Formato da mensagem) \n
\n
Autenticação
\nO Bearer token é um token JWT que deve ser validado de acordo com o issuer, data de expiração e com a chave pública disponibilizada pela CCEE no formato JWKS.
\nExemplo de uma requisição no formato HAR (HTTP Archive):
\n{\n \"log\": {\n \"version\": \"1.2\",\n \"creator\": {\n \"name\": \"Webhook.site\",\n \"version\": \"1.0\"\n },\n \"entries\": [{\n \"startedDateTime\": \"2024-09-02 19:04:20\",\n \"request\": {\n \"method\": \"POST\",\n \"url\": \"https://webhook.site/73fa9a3e-0bce-43b7-ba2a-7ce1c387b0ee\",\n \"headers\": [{\n \"name\": \"content-length\",\n \"value\": \"206\"\n }, {\n \"name\": \"host\",\n \"value\": \"webhook.site\"\n }, {\n \"name\": \"authorization\",\n \"value\": \"Bearer ...token...\"\n }, {\n \"name\": \"user-agent\",\n \"value\": \"CCEE Webhook API\"\n }, {\n \"name\": \"content-type\",\n \"value\": \"application/json\"\n }, {\n \"name\": \"accept\",\n \"value\": \"text/plain, application/json, application/cbor, application/*+json, */*\"\n }\n ],\n \"bodySize\": 206,\n \"postData\": {\n \"mimeType\": \"application/json\",\n \"text\": \"{\\\"id\\\":\\\"b6842bdc-5bcb-4b8d-81ec-210e4153b261\\\",\\\"versao\\\":\\\"1\\\",\\\"dataRegistro\\\":\\\"2024-09-02T16:03:38.341-03:00\\\",\\\"origem\\\":\\\"ORIGEM\\\",\\\"tipoEnvioNotificacao\\\":\\\"TIPO\\\",\\\"descricoes\\\":[{\\\"conteudo\\\":\\\"{\\\\\\\"key\\\\\\\":\\\\\\\"conteudo\\\\\\\"}\\\"}]}\"\n }\n },\n \"response\": {\n \"status\": 200,\n \"httpVersion\": \"HTTP/1.1\",\n \"headers\": [{\n \"name\": \"Content-Type\",\n \"value\": \"text/html\"\n }\n ]\n }\n }\n ]\n }\n}\n\nFormato da mensagem
\n\n
O conteúdo da mensagem do webhook, na sua versão inicial 1, segue o schema abaixo:
\n{\n \"$schema\": \"https://json-schema.org/draft-04/schema\",\n \"title\": \"Mensagem\",\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"description\": \"Identificador\",\n \"type\": \"string\"\n },\n \"versao\": {\n \"description\": \"Versão desta mensagem\",\n \"type\": \"string\"\n },\n \"dataRegistro\": {\n \"description\": \"Data de criação desta mensagem\",\n \"type\": \"string\"\n },\n \"origem\": {\n \"description\": \"Origem da notificação\",\n \"type\": \"string\"\n },\n \"tipoEnvioNotificacao\": {\n \"description\": \"Tipo da notificação\",\n \"type\": \"string\"\n },\n \"descricoes\": {\n \"type\": \"array\",\n \"minItems\": 1,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"conteudo\": {\n \"description\": \"Conteúdo (valor) da notificação em si, a depender de sua ORIGEM/TIPO\",\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nPara o projeto de Abertura de Mercado, o campo origem é fixo em ABERTURA_MERCADO.
\nExemplo:
\n{\n \"id\": \"a9c9f679-0d9d-4c35-932d-fdb479601649\",\n \"versao\": \"1\",\n \"dataRegistro\": \"2024-01-01T00:00:00-03:00\",\n \"origem\": \"ABERTURA_MERCADO\",\n \"tipoEnvioNotificacao\": \"CONTRATO_CCV_CONCLUIDO\",\n \"descricoes\": [\n {\n \"conteudo\": \"{\\\"idContrato\\\": \\\"123-123-123-123\\\", \\\"situacaoContrato\\\": \\\"CANCELADO\\\", \\\"codigoUnidadeConsumidora\\\": 123}\"\n }\n ]\n}\n\nEsse módulo para notificações foi criado para promover a iteração da CCEE com os agentes e, até mesmo entre os agentes, por meio de mensagens no padrão Webhook.
\nEstabelecer a conexão com o sistema de notificação da CCEE é fundamental para operação no mercado livre de energia, de modo que auxilia no atendimento de todos os prazos da regulação.
\nEsse módulo é divido em quatro partes:
\n- \n
Endpoint de Recebimento de Mensagem: Para recebimento da mensagem é necessário informar um canal de comunicação para que a CCEE possa enviar as mensagens. Esse módulo disponibilizará um API para o cadastro do endpoint.
\n \nAPI para consulta do endpoint: API para consulta do endpoint cadastrado para recebimento das mensagens oriundas da CCEE.
\n \nAPI para obter certificado: API para retornar o certificado para validação do token enviado na mensagem de notificação;
\n \nEstrutura da Interface de Recebimento da Mensagem: Para recebimento das mensagens é necessário estar em conformidade com o padrão de especificação da API. Essa especificação contém a composição do formato dos dados, estrutura dos dados e configuração de segurança.
\n \n
(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"(Required) Código do Perfil
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"codigoUnidadeConsumidora\": \"TESTE\",\n \"codigoAgenteConcessionaria\": 100000,\n \"tipoDocumento\": \"CNPJ\",\n \"numeroDocumento\": \"999999999999999\",\n \"codigoAgenteVarejista\": 200000,\n \"mesReferencia\": \"2025-03\",\n \"dataDenuncia\": \"2024-06-02\",\n \"codigoPerfilVarejista\": 200101,\n \"emailUnidadeConsumidora\":\"teste@teste.com\",\n \"comentario\":\"TESTE CCEE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api-abm.ccee.org.br/v1/varejista/migracoes","description":"API para Cadastro
\nAPI que trata do envio dos dados cadastrais da unidade consumidora pelo agente varejista.
\nPara migrações de unidades consumidores de pessoas físicas, não existe a obrigatoriedade do envio do número do documento.
\n","urlObject":{"protocol":"https","path":["v1","varejista","migracoes"],"host":["api-abm","ccee","org","br"],"query":[],"variable":[]}},"response":[{"id":"9cf0d0bc-f37b-4161-96c0-ac3b99119a92","name":"OK","originalRequest":{"method":"POST","header":[{"description":"(Required) Código do Agente","key":"codigoAgente","value":"(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"(Required) Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-abm.ccee.org.br/v1/varejista/migracoes?codigoUnidadeConsumidora=TESTE&mesReferenciaInicial=2025-01&mesReferenciaFinal=2025-12&codigoPerfilVarejista=200101&statusMigracao=CONCLUIDA&indexProximaPagina=API para consulta
\nAPI para consulta dos dados cadastrados pelo varejista e distribuidora.
\nLista dos possíveis status de migração e sua descrição:
\n- \n
CRIADA = Momento em que a solicitação é criada pelo varejista.
\n \nCONCLUIDA = Momento em que a solicitação é Concluída pela concessionária.
\n \nREPROVADA = Momento em que a solicitação é Reprovada pela concessionária.
\n \nENCERRADA = Momento em que a solicitação foi Encerrada e existe histórico.
\n \nCANCELADA = Momento em que a solicitação foi Cancelada e NÃO existe histórico.
\n \nEXPIRADA = Momento em que a solicitação foi expirada por não ser CONCLUÍDA e nem REPROVADA. Exemplo: Varejista criou a migração da UC, mas a concessionária não validou e nem rejeitou a migração e o prazo expirou em M-12
\n \n
Operação de consulta paginada às migrações cadastradas. Verificar o objeto 'indexProximaPagina' ao final de cada página para navegar nos resultados. Não enviar esse filtro na primeira pesquisa.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","name":"Abertura de Mercado","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","varejista","migracoes"],"host":["api-abm","ccee","org","br"],"query":[{"description":{"content":"Código da Unidade Consumidora
\n","type":"text/plain"},"key":"codigoUnidadeConsumidora","value":"TESTE"},{"description":{"content":"(Required) Mês Referência Inicial
\n","type":"text/plain"},"key":"mesReferenciaInicial","value":"2025-01"},{"description":{"content":"(Required) Mês Referência Final
\n","type":"text/plain"},"key":"mesReferenciaFinal","value":"2025-12"},{"description":{"content":"(Required) Código do Perfil Varejista
\n","type":"text/plain"},"key":"codigoPerfilVarejista","value":"200101"},{"description":{"content":"Status da Migração
\n","type":"text/plain"},"key":"statusMigracao","value":"CONCLUIDA"},{"description":{"content":"Index para a próxima página de resultados, quando houver
\n","type":"text/plain"},"key":"indexProximaPagina","value":"(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"(Required) Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-abm.ccee.org.br/v1/varejista/migracoes/:idMigracao","description":"API para obter as informações detalhadas da migração por meio de seu identificador.
\n","urlObject":{"protocol":"https","path":["v1","varejista","migracoes",":idMigracao"],"host":["api-abm","ccee","org","br"],"query":[],"variable":[{"description":{"content":"(Required) Identificador da Migração
\n","type":"text/plain"},"type":"any","value":"commodo do","key":"idMigracao"}]}},"response":[{"id":"70bc5043-ff1e-4bee-9bb0-5d9386dcd71c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"(Required) Código do Agente","key":"codigoAgente","value":"-27190017"},{"description":"(Required) Código do Perfil","key":"codigoPerfil","value":"-27190017"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCódigo do Agente
\n"},{"key":"codigoPerfil","value":"162450470","description":"Código do Perfil
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"codigoAgenteConcessionaria\": 9999,\n \"codigoAgenteVarejista\": 9999,\n \"codigoPerfilVarejista\": 9999,\n \"codigoUnidadeConsumidora\": \"710806976321234\",\n \"emailUnidadeConsumidora\": \"emailcontato@teste.org.br\",\n \"formalizacaoDistribuidora\": \"SIM\",\n \"mesReferencia\": \"2024-04\",\n \"subGrupoTarifarioUnidadeConsumidora\": \"A3a\",\n \"tipoDocumento\": \"CNPJ\",\n \"numeroDocumento\": \"04252011001234\",\n \"dataFormalizacao\": \"2024-04-27\",\n \"modalidadeMigracao\": \"ANTECIPADA\",\n \"comentario\": \"Texto livre\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api-abm.ccee.org.br/v2/varejista/migracoes","urlObject":{"protocol":"https","path":["v2","varejista","migracoes"],"host":["api-abm","ccee","org","br"],"query":[],"variable":[]}},"response":[{"id":"aba5b6ce-1080-4f3c-b636-8d1a486b65d1","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Código do Agente","key":"codigoAgente","value":"162450470"},{"description":"Código do Perfil","key":"codigoPerfil","value":"162450470"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCódigo do Agente
\n"},{"key":"codigoPerfil","value":"162450470","description":"Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-abm.ccee.org.br/v2/varejista/migracoes?codigoUnidadeConsumidora=string&mesReferenciaInicial=2024-01&mesReferenciaFinal=2024-12&codigoPerfilVarejista=2882&statusMigracao=REPROVADA&indexProximaPagina=string","urlObject":{"protocol":"https","path":["v2","varejista","migracoes"],"host":["api-abm","ccee","org","br"],"query":[{"description":{"content":"Código da Unidade Consumidora
\n","type":"text/plain"},"key":"codigoUnidadeConsumidora","value":"string"},{"description":{"content":"Mês Refêrencia Inicial
\n","type":"text/plain"},"key":"mesReferenciaInicial","value":"2024-01"},{"description":{"content":"Mês Refêrencia Final
\n","type":"text/plain"},"key":"mesReferenciaFinal","value":"2024-12"},{"description":{"content":"Código do Perfil Varejista
\n","type":"text/plain"},"key":"codigoPerfilVarejista","value":"2882"},{"description":{"content":"Status da Migração
\n","type":"text/plain"},"key":"statusMigracao","value":"REPROVADA"},{"description":{"content":"Index para a próxima página de resultados, quando houver
\n","type":"text/plain"},"key":"indexProximaPagina","value":"string"}],"variable":[]}},"response":[{"id":"64c3f82e-9ad4-41d8-a13c-8813fc79c204","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Código do Agente","key":"codigoAgente","value":"162450470"},{"description":"Código do Perfil","key":"codigoPerfil","value":"162450470"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCódigo do Agente
\n"},{"key":"codigoPerfil","value":"162450470","description":"Código do Perfil
\n"},{"key":"Accept","value":"application/json"}],"url":"https://api-abm.ccee.org.br/v2/varejista/migracoes/:idMigracao","urlObject":{"protocol":"https","path":["v2","varejista","migracoes",":idMigracao"],"host":["api-abm","ccee","org","br"],"query":[],"variable":[{"description":{"content":"Identificador da Migração
\n","type":"text/plain"},"type":"any","value":"6fefed48-9813-415a-9600-bc20d12c8d10","key":"idMigracao"}]}},"response":[{"id":"9d0a8eb0-d643-44d3-b3f4-cd7a8250ff50","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Código do Agente","key":"codigoAgente","value":"162450470"},{"description":"Código do Perfil","key":"codigoPerfil","value":"162450470"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerO serviço de “cadastro e migração” consiste na troca de informações ágeis entre varejista, CCEE e concessionária para efetivar a migração para o mercado livre de uma nova unidade consumidora. Assim, o agente varejista, uma vez “fechado o negócio” com o consumidor, assinado o Contrato de Comercialização Varejista (CCV) e realizado a carta denúncia para a concessionária, deve informar à CCEE qual Unidade Consumidora (UC), da respectiva concessionária, que vai ser representado por este varejista, em seu perfil contábil, a partir da data determinada para a migração. A concessionária, por sua vez, deve confirmar essas informações, validando a possibilidade de migração para a data pretendida, com o acréscimo da informação do histórico de consumo e do submercado desse consumidor. Uma vez feita a validação da concessionária, o consumidor está oficialmente migrado para o Ambiente de Contratação Livre (ACL).
\nO esquema desse processo pode ser resumido na figura abaixo:
\n(Required) Código do Agente
\n"},{"key":"codigoPerfil","value":"(Required) Código do Perfil
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mesReferencia\": \"2025-03\",\n \"codigoPerfilVarejista\": 200101,\n \"tipoDocumento\": \"CNPJ\",\n \"numeroDocumento\": \"99999999999999\",\n \"emailUnidadeConsumidora\": \"teste@teste.com\",\n \"statusMigracao\": \"CANCELADA\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api-abm.ccee.org.br/v1/varejista/migracoes/:idMigracao","description":"A API API nº 5 da Figura 3 possui o padrão abaixo para envio do agente varejista para troca do perfil de agente.
\nO agente varejista pode, quando necessário, alterar para os meses futuros o código do perfil de agente.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","id":"9e38ca63-0335-4ced-8614-6b2bfd072b2b","name":"Abertura de Mercado","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","varejista","migracoes",":idMigracao"],"host":["api-abm","ccee","org","br"],"query":[],"variable":[{"description":{"content":"(Required) Identificador da Migração
\n","type":"text/plain"},"type":"any","value":"434a44b9-eF2C-a8da-6EB2-1fB3c1e019Ea","key":"idMigracao"}]}},"response":[{"id":"39a7870b-bbad-4e8b-a743-427042641afd","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"(Required) Código do Agente","key":"codigoAgente","value":"