SOLARZ-MONITORAMENTO
SOLARZ-MONITORAMENTO

šŸ“Š API SOLARZ

Criando um usuƔrio de acesso Ơ API

Para consumir a Open API da Solarz, Ć© necessĆ”rio gerar um usuĆ”rio especĆ­fico para autenticaĆ§Ć£o.

Passo 1: Acesse a tela de UsuƔrio de API

  1. No menu lateral, clique em ConfiguraƧƵes.

  2. Role a lista de opƧƵes atƩ o final e selecione UsuƔrio de API.

  3. Na tela exibida, clique no botĆ£o + Gerar UsuĆ”rio de API.

ObservaĆ§Ć£o: Caso ainda nĆ£o exista um usuĆ”rio de API cadastrado, a tela exibirĆ” a mensagem informando que nenhum usuĆ”rio foi criado e disponibilizarĆ” o botĆ£o Gerar UsuĆ”rio de API.

image-20260716-134729.png

Passo 2: Copie as credenciais geradas

ApĆ³s clicar em Gerar UsuĆ”rio de API, o sistema exibirĆ” uma janela contendo as credenciais de acesso.

Nessa janela serĆ£o apresentados:

  • UsuĆ”rio: identificador que serĆ” utilizado para autenticaĆ§Ć£o.

  • Senha: senha de acesso da API.

Clique no botĆ£o Copiar ao lado de cada campo para copiar as credenciais.

Importante: A senha serĆ” exibida apenas uma Ćŗnica vez. Guarde essas informaƧƵes em um local seguro, pois nĆ£o serĆ” possĆ­vel visualizĆ”-la novamente. Caso a senha seja perdida, serĆ” necessĆ”rio gerar um novo usuĆ”rio de API.

Essas credenciais deverĆ£o ser utilizadas na autenticaĆ§Ć£o HTTP Basic (Basic Auth) ao realizar chamadas para a Open API da Solarz.

image-20260716-134904.png

Acessando a Open API da Solarz

Para integrar sua aplicaĆ§Ć£o com a Open API da Solarz, siga as instruƧƵes abaixo.

1. Consulte a documentaĆ§Ć£o da API

A documentaĆ§Ć£o completa, contendo a descriĆ§Ć£o dos endpoints, exemplos de requisiĆ§Ć£o e respostas, estĆ” disponĆ­vel no SwaggerHub:

2. AutenticaĆ§Ć£o

A Open API da Solarz utiliza o mĆ©todo de autenticaĆ§Ć£o Basic Authentication (Basic Auth).

3. Importe a coleĆ§Ć£o no Postman

Para visualizar todos os endpoints disponĆ­veis e seus respectivos parĆ¢metros de forma prĆ”tica, importe o schema OpenAPI no Postman utilizando o link abaixo:

Planilha API

A planilha API pode ser utilizar para conseguir acesso a dados de informaƧƵes de usinas premium em massa, para que possa haver integraĆ§Ć£o da planilha com os dados da solarz Ć© necessĆ”rio que o integrador baixe a planilha disponibilizado no link: Planilha API

ApĆ³s clicar no link, Ć© necessĆ”rio clicar nos 3 pontinhos do lado esquerdo e clicar em "Baixar"

image-20250127-124251.png

ApĆ³s realizar o download da planilha caso apareƧa um aviso de seguranƧa Ć© necessĆ”rio que clique em habilitar conteĆŗdo.

image-20250127-124326.png

ApĆ³s habilitar conteĆŗdo Ć© necessĆ”rio que o integrador faƧa login na planilha, para fazer login Ć© necessĆ”rio que clique em consulta, editar.

image-20250127-124415.png

ApĆ³s clicar em editar vocĆŖ serĆ” redirecionado para outra aba, para fazer login clique em editar credencial.

image-20250127-124452.png

Ao clicar em editar credencial vocĆŖ serĆ” direcionado para outra aba, serĆ” necessĆ”rio que clique na aba bĆ”sico. Em seguida vocĆŖ irĆ” adicionar o login e senha da conta principal da solarz. ApĆ³s inserir login e senha da conta principal clique em conectar.

image-20250127-124520.png

ApĆ³s conectar vocĆŖ pode fechar a aba seguinte. Para que a planilha colete as informaƧƵes da solarz vocĆŖ vai selecionar cada aba de forma individual e vai clicar em atualizar . ObservaĆ§Ć£o: Orientamos que atualize a aba faturas por Ćŗltimo.

image-20250127-124620.png

ApĆ³s atualizar todas as abas a sua planilha jĆ” vai estar com os dados da sua conta solarz.