O que este endpoint faz
O endpoint Informe de Contador permite que sistemas externos enviem leituras de contadores associados a equipamentos cadastrados no Keepfy, garantindo que seja mantido o histórico de medições atualizado.
Pré-requisitos
Conta ativa no Keepfy;
Usuário com perfil administrador para realizar a configuração;
Configurar sistema para receber mensagem.
Configurações necessárias
Em 'Minha Conta', acesse a opção 'Integração';
Clique em sobre a seção de integração 'Equipamento';
Verifique se não há uma integração 'Custom' habilitada, ela pode conter o endpoint de informe de contador. Caso não tenha, clique em 'Nova Integração'.
No passo 1, nomeie sua integração. Este campo é livre, mas recomendamos que você escolha um nome que caracterize o processo desejado.
No passo 2, crie um grupo de filiais. Ou seja, você pode organizar o recebimento de mensagens por grupos de filiais e a configuração escolhida estará atrelada aquele grupo, com diferenças entre códigos de empresa e filial que serão vistos no passo 4.
No passo 3, atente-se aos metadados escolhidos. Clique em 'Novo Metadado', dê um nome para caracterizar, e selecione o endpoint desejado, no contexto desde exemplo, escolha Informe de Contador.
Ainda no passo 3 veja que ao escolher o endpoint de Informe de Contador campos padrão são carregados. Campos internos são aqueles em que formatos vamos identificar e receber, campos externos podem ser alterados conforme a requisição do cliente, porém é importante manter a correlação correta conforme a mensagem de requisição enviada e o processo desejado. Mais detalhes sobre os campos serão apresentados em 'Dicionário de campos';
Para fins didáticos, neste momento, faremos a alteração de alguns campos com novas chaves:
Desta forma, a requisição deve estar de acordo com as chaves - veremos abaixo em 'exemplo prático';
Confirme e prossiga para o último passo;
No último passo, onde são listadas as filiais, informe o código da empresa e da filial para facilitar a identificação conforme a necessidade de passagem de parâmetros. Não esqueça de salvar a edição.
Ao avançar a configuração estará terminada e pronta para ser utilizada.
Exemplos práticos
Abaixo apresentamos alguns exemplos práticos para facilitar o entendimento referente ao uso.
1 - Registro de Informe de Contador (POST)
A requisição deve ser enviada para: https://api.keepfy.com/v1/informcounter
O tipo de autenticação é 'Basic authorization', isso é, usuário e senha Keepfy com acesso a registros de contadores. Portanto, um usuário com perfil de executor ou planejador.
Informe os parâmetros obrigatórios: companyId e branchId, conforme configurados;
A execução deve retornar mensagem semelhante a abaixo. Exemplo de requisição feita com o software Insomnia:
Considerações importantes
Cada chamada ao endpoint gera um novo registro no histórico do contador;
O valor informado não sobrescreve leituras anteriores;
O contador informado deve estar previamente cadastrado e vinculado ao equipamento;
Dicionário de campos
Chaves internas
Correspondência Sistema | Valor |
Identificação (Equipamento) | equipmentTag |
Data e Hora de Leitura | readAt |
Posição | position |
Referência técnica
Metadados: são dados que descrevem outros dados, fornecendo contexto e informações como origem, formato, significado e uso para facilitar sua organização, busca e compreensão
Processos relacionados