devccee / guia-primeiros-passos

Um guia para iniciar o uso de serviços da plataforma de integração da ccee.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Guia prático: O primeiro uso da Plataforma de Integração

  • O que é a Plataforma de Integração?
  • Quem pode acessar a Plataforma de Integração?
  • O que é o ambiente piloto?
  • O que preciso para acessar à Plataforma de Integração?
  • Quais as características do certificado digital?
  • Quais certificados digitais não são válidos?
  • Como cadastrar o certificado digital nos nossos sistemas?
  • Como é feita a autenticação à Plataforma de Integração?
  • Como configurar a autenticação mútua no Postman?
  • O que significa o código de perfil do agente?
  • Como validar a conexão após receber o usuário e senha sistêmicos?
  • Como abrir chamados para a CCEE referente a erros/dúvidas sobre os serviços da Plataforma?

O que é a Plataforma de Integração?

Plataforma tecnológica que viabiliza a integração segura entre os sistemas de informação da CCEE e os demais participantes do mercado de energia, propiciando aumento de produtividade e redução de custos e riscos operacionais, conforme figura abaixo.

Plataforma Diagrama

Abstraindo o conceito de "Barramento" de serviços, se você precisasse obter água do encanamento da sua casa você teria este cenário:

Encanamento CCEE


Quem pode acessar a Plataforma de Integração?

QuemPodeUtilizar

Todos os agentes e não agentes aderidos à CCEE. Caso queira consultar informações em nome de outro agente que não esteja aderido à Plataforma de Integração é necessário que tenha representação operacional total do agente representado.


O que é o ambiente piloto?

Um ambiente de teste que pode ser utilizado para conhecer na prática os serviços disponibilizados no ambiente produtivo da Plataforma de Integração. Você pode cadastrar novos contratos sem alterar as informações contidas no ambiente produtivo, aprender como consultar as medições dos agentes antes, aprender a consultar os preços com o serviço de PLD entre outras funcionalidades. Todos os serviços que estão em produção estão no piloto exceto a DRI, que exige um alto processamento do ambiente.

  • Diferença de produção: 1 mês.
  • Quando ele é atualizado? Sempre no primeiro sábado do mês corrente.
  • Como é acessado ? Igual produção, ou seja, com os mesmos usuários, senhas e certificados.
  • Disponibilidade: por possuir menos recursos computacionais comparado com produção, o ambiente piloto não é 24/7.
  • Caso encontre algum erro, favor abrir chamado para e-mail: atendimento@ccee.org.br, com o assunto "Erro no Ambiente piloto".

O que preciso para acessar à Plataforma de Integração?

Para acessar os serviços por meio da Plataforma você precisará:

  • Liberar o firewall para comunicação com as portas 442 e 443 no endereço https://servicos.ccee.org.br/ (para o ambiente produtivo) e no endereço https://piloto-servicos.ccee.org.br/ (para o ambiente piloto).
  • Aderir à Plataforma de Integração, de acordo com o Manual de adesão/atualização de certificado.
  • Utilizar o usuário e senha cadastrados após a conclusão da adesão à Plataforma de Integração;
  • Utilizar a chave PRIVADA, geralmente possui extensão (*.pfx, *.p12, entre outras) do certificado aderido para realizar a comunicação com a CCEE;
  • Informar o código do perfil de agente.

Para utilizar os serviços da Plataforma de Integração, fazemos duas verificações:

  1. Autenticação - Validamos se o usuário e senha sistêmicos e certificado digital estão corretos.
  2. Autorização - Utilizamos o código do perfil de agente, contido no "Header" da mensagem enviada para identificar em nome de qual perfil o usuário logado está tentando acessar.

Você só pode utilizar o seu código perfil ou dos agentes que você representa operacionalmente para fazer as requisições na Plataforma. Caso contrário o erro "Rejected: Usuário não está autorizado a usar o codigoPerfilAgente" será retornado.


Quais as características do certificado digital?

  • Certificado para Servidor Web – SSL
  • Hierarquia: ICP-Brasil
  • Tamanho da chave: RSA 2048 bits
  • Data de Expiração menor que 395 dias
  • Algoritmo do certificado: SHA 2 (256) ou SHA 2 (512)
  • Requerente (subject) precisa ser único por certificado

A CCEE utiliza apenas os atributos listados acima para realizar a autenticação mútua. Os demais atributos do certificado podem ser utilizados conforme a preferência dos agentes.

Importante:

A chave pública do cerificado digital deve ser enviada na Plataforma Cadastral para adesão e atualização do certificado de acesso à Plataforma de Integração. A chave pública deve ser exportada em formato X.509 binário codificado por DER.

Siga as orientações do Manual de Adesão/Atualização para exportar a chave pública no formato correto.

Caso não submeta o arquivo no formato binário, um erro de "CERTIFICADO EXPIRADO" na tela do SGP poderá ocorrer.


Quais certificados digitais não podem ser utilizados?

  • Não é um certificado para sites.
  • Não é um certificado A1 onde a assinatura fica armazenada no próprio computador do usuário.
  • Não é um certificado A3 onde a assinatura fica armazenada em mídias portáteis, tais como token USB ou cartões com chip.
  • Não é um certificado de Emissão Nota Fiscal.
  • Não é um e-CPF.

Como cadastrar o certificado digital nos nossos sistemas?

Para cadastrar o certificado digital você utilizará a chave-pública que geralmente possui a extensão (*.cer, *.crt, entre outras).

O cadastro inicial, assim como também a atualização ANUAL da chave-pública e o seu passo-a-passo para aderir à Plataforma de Integração é descrita neste Manual de Adesão.


Como é feita a autenticação à Plataforma de Integração?

A autenticação realizada pela plataforma é a autenticação mútua. Para mais informações consulte o Manual de Autenticação.


Como Configurar autenticação SSL mútua no Postman

Um dos requisitos para autenticação nos serviços da Plataforma de Integração é a autenticação SSL mútua. Isso quer dizer que, ao acessar os web services da CCEE, será necessário utilizar uma chave privada de um certificado previamente cadastrado na Plataforma de Integração.

Os passos abaixo mostram como configurar sua chave privada no Postman:

  1. Verifique se tem acesso à sua chave privada, em arquivo no formato *.PFX, *.P12, *.JKS ou similar

  2. No Postman, acesse File > Settings Postman - Howto 2Way SSL

  3. Adicione o arquivo com sua chave privada no campo PFX File, informando a senha do arquivo, e adicione o endereço com o valor *.ccee.org.br no campo Host

Postman - Howto 2Way SSL

O que significa o código de perfil do agente??

O código de perfil do agente representa o perfil do agente dentro da CCEE. O perfil é uma forma de diferenciar o tratamento atribuído na contabilização entre usinas e cargas de um mesmo agente. Por exemplo, um mesmo agente pode ter uma usina com energia incentivada e outra com energia convencional, tendo os tratamentos adequados na contabilização para tipo de energia. Já para cargas aplica-se o mesmo conceito, perfis diferentes permitem que sejam contabilizadas cargas com características diferentes, como por exemplo cargas sujeitas a desconto ou sem desconto. Resumindo, o perfil é como o agente monta as suas contratações de energia.

  • Cuidado para não confundir o código do agente com o código do perfil do agente.

Sua consulta pode ser feita pela Plataforma Cadastral, como também da planilha Infomercado Dados Individuais, encontrada nos documentos do site da CCEE. A informação também consta na consulta do serviço Perfil Participante Mercado.

Esta informação deverá ser enviada no "Header" de todas as requisições da Plataforma de Integração.


Como validar a conexão após receber o usuário e senha sistêmicos?

Os serviços foram criados para serem acessados por outros sistemas, por meio da troca de mensagens, o que facilita o acesso às informações, mitigando erros que podem ser provenientes de atividades manuais. Existem algumas ferramentas no mercado específicas para testar os serviços ou APIs, tais como SoapUi, Postman, entre outros. Com elas os agentes conseguem validar a conexão com o serviço de interesse enquanto desenvolve a sua solução.

A CCEE não presta suporte sobre o uso da ferramenta Postman, mas disponibiliza uma coleção de exemplos de chamada dos serviços existentes na Plataforma para consulta e utilização entre os agentes.

Para fazer isso siga os passos abaixo:

  • Escolha um serviço de interesse - Clique aqui.

  • Configure a autenticação via postman - Clique aqui. Mais detalhes na sessão - Como Configurar autenticação SSL mútua no Postman

  • Navegue pelos exemplos de consulta desejados para o serviço alvo - Clique aqui

  • Não esqueça de conferir se as credenciais do usuário e senha sistêmicos estão corretamente configuradas e se é necessário inserir o código do perfil de agente principal no Header da chamada.


Como abrir chamados para a CCEE referente a erros/dúvidas sobre os serviços da Plataforma?

Basta enviar um e-mail para o endereço ou ligar para o telefone acima.

Ao criar um chamado sobre algum serviço ou problema específico, anexar os arquivos xml da chamada de serviço e da resposta, contendo o campo "transactionId". Com este campo conseguimos rastrear a sua mensagem nos nossos arquivos de log para uma análise efetiva do seu problema. Se ainda sentir que falta alguma coisa para entendimento completo do chamado, adicione "prints de tela" em anexo.


Referências

About

Um guia para iniciar o uso de serviços da plataforma de integração da ccee.