Sorry, your browser does not suporte JavaScript!
Entrar

Como usar a IAMMETER-cloud de forma mais eficiente com a API

Pré-requisito

A IAMMETER-cloud fornece algumas APIs, e o desenvolvedor pode usar essas APIs para realizar trabalhos interessantes, como integrar os dados da IAMMETER a algum sistema de terceiros. Disponibilizamos essas APIs apenas para nossos parceiros de negócios e alguns grandes clientes antes, mas decidimos abri-las para todos os nossos clientes agora.

Compartilhe suas opiniões conosco em nosso fórum. https://imeter.club

Limite da API

A API não pode ser acessada ilimitadamente, limitaremos o número de chamadas diárias para cada API. Por favor, não chame a API com muita frequência.

Se o número de chamadas exceder o limite horário ou diário, a API não retornará nada.

API tipo de limite horário diário descrição
1 /user/login ip 5 30 apenas um IP pode chamar esta api 5 vezes por hora
2 /site/meterdata/ SN 12 apenas um SN pode chamar esta api 12 vezes por hora
3 /site/powerAnalysis SN 5 apenas um SN pode chamar esta api 5 vezes por dia
4 /site/offlineAnalysis SN 5 apenas um SN pode chamar esta api 5 vezes por dia

Conta: Obter o token da conta

Retorna o token da conta. O token será usado em quase todas as APIs.

Você não precisa chamar esta API, a menos que queira atualizar o token. Por favor, não chame esta API mais de 5 vezes em uma hora, e não mais de 30 vezes em um dia.

URL e Método

Obtenha o token da conta que é usado em todas as APIs.

URL: https://www.iammeter.com/api/v1/user/login

Método: post

Esta api pode ser testada online em IAMMETER SwaggerUI get token

Dados

parâmetro observação exemplo
1 user name Nome de usuário da IAMMETER test
2 password senha da IAMMETER 123456

Resposta

O valor do token será usado em todas as APIs abaixo.

{
    "data": {
        "id": 2025,
        "token": "349dfxxxxxxac5169",
        "refreshToken": "8adf75e5da10424985f3b83855133982"
    },
    "successful": true,
    "message": null
}

Obter o token diretamente do sistema web

Este token também pode ser lido diretamente após você fazer login no sistema.

image-20230921163110697

Medidor de Energia: Obter os dados de upload mais recentes e a hora UTC

Obtenha os últimos dados de upload com o SN correspondente.

Por favor, não chame esta API mais de 12 vezes em uma hora.

URL e Método

Básico (meterdata): https://www.iammeter.com/api/v1/site/meterdata/{sn}

Esta api pode ser testada online em IAMMETER SwaggerUI

Avançado (meterdata2): https://www.iammeter.com/api/v1/site/meterdata2/{sn}

Esta api pode ser testada online em IAMMETER SwaggerUI meterdata e IAMMETER SwaggerUI meterdata2

Método: GET

Limite: por favor, não solicite esta API mais de 288 vezes por dia (intervalo de 5 minutos).

A diferença entre básico e avançado:

Básico: sem FP (Fator de potência)

Avançado: com FP (Fator de potência)

Parâmetros

Nome Tipo Exemplo
Token String xxx obrigatório
rtctime string 2025-6-16 opcional

Resposta: monofásico - meterdata (sem Fator de potência)

definição dos valores: tensão, corrente, potência ativa, kWh importado, kWh exportado

{
    "data": {
        "values": [
            [
                230.220, //tensão
                1.300, //corrente
                119.000,//potência ativa
                1766.590, //kWh importado
                0.000 //kWh exportado
            ]
        ],
        "localTime": "2020/8/28 15:27:33",
        "gmtTime": "2020/8/28 5:27:33"
    },
    "successful": true,
    "message": null
}

Resposta: monofásico - meterdata2 (com Fator de potência)

definição dos valores: tensão, corrente, potência ativa, fator de potência, kWh importado, kWh exportado.

Embora reconheçamos que colocar o fator de potência entre a potência ativa e a energia importada não seja o ideal, o formato atual já está configurado desta forma—por favor, esteja ciente deste arranjo.

{
    "data":{
        "values":[
            [
                233.41, //tensão
                0.718,//corrente
                111,//potência ativa
                0.66,//fator de potência
                5724.85, //energia importada
                0 //energia exportada
            ]
        ],
        "localTime":"2023/11/21 14:30:22",
        "gmtTime":"2023/11/21 6:30:22"
    },
    "successful":true,
    "message":null
}

Resposta: trifásico - meterdata (sem Fator de potência)

Os três arrays em values representam a Fase A, Fase B e Fase C.

definição dos valores: tensão, corrente, potência ativa, kWh importado, kWh exportado

{
    "data": {
        "values": [
            [
                242.600,//tensão
                1.000,//corrente
                216.000,//potência ativa
                32354.600,//energia importada
                0.000//energia exportada
            ],
            [
                242.600,
                1.000,
                1986.000,
                30536.410,
                17704.720
            ],
            [
                0.000,
                0.000,
                0.000,
                0.000,
                0.000
            ]
        ],
        "localTime": "2020/8/28 15:30:48",
        "gmtTime": "2020/8/28 5:30:48"
    },
    "successful": true,
    "message": null
}

Resposta: trifásico - meterdata2 (com Fator de potência)

Definição dos elementos: tensão, corrente, potência ativa, fator de potência, kWh importado, kWh exportado

{
    "data":{
        "values":[
            [//fase A
                233.8,//tensão
                0.03,//corrente
                4,//potência ativa
                0.57,//fator de potência
                222.53,//kWh importado
                0 //kWh exportado
            ],
            [//fase B
                5,
                0,
                0,
                0,
                0,
                0
            ],
            [ //fase C
                3.1,
                0,
                0,
                0,
                0,
                0
            ]
        ],
        "localTime":"2023/11/21 14:39:36",
        "gmtTime":"2023/11/21 6:39:36"
    },
    "successful":true,
    "message":null
}

Exemplo (obter o valor de upload mais recente)

image-20230921164457116

Exemplo (obter o valor próximo ao horário RTC específico)

O RTC (Relógio de Tempo Real) também é um parâmetro na solicitação HTTP GET, conforme mostrado abaixo:

https://www.iammeter.com/api/v1/site/meterdata/59C9AB8D?token=336c9cbebcbf49139f0be060cc7ba7fd&rtctime=2025-6-16

Esta solicitação retornará o valor dos dados de medidor mais próximo da data especificada (2025-6-16), ou seja, o ponto de tempo registrado mais próximo.

Medidor de Energia: Obter o histórico

Observação: estas APIs são as mesmas do capítulo anterior, apenas adicionam mais alguns parâmetros

Retorna os dados históricos no intervalo e período de tempo definidos.

  • período de tempo: último mês
  • comprimento máximo de dados: 2000 registros

Os dados instantâneos estão em intervalo de 1 minuto. Existem 60*24=1440 dados por dia. Se você solicitar dados históricos em intervalo de 1 minuto, só poderá solicitar dados de 1,39 (2000/1440) dias. Mas se você solicitar dados em intervalos de 5 minutos, poderá solicitar dados de quase 7 dias.

URL e Método

Básico (meterdatalist):https://www.iammeter.com/api/v1/site/meterdatalist/

**Avançado (meterdatalist2):**https://www.iammeter.com/api/v1/site/meterdatalist2/{sn}

A diferença entre básico e avançado:

Básico: sem FP (Fator de potência)

Avançado: com FP (Fator de potência)

Esta api pode ser testada online em IAMMETER SwaggerUI meterdata e IAMMETER SwaggerUI meterdata2

Parâmetros

Nome Tipo Exemplo
Token String xxx obrigatório
interval number 300 obrigatório, unidade: segundo
startTime string 2023-09-01 obrigatório
endTime string 2023-09-07 obrigatório

Resposta: monofásico - meterdatalist

Dados:[tensão, corrente, potência, energia importada, energia exportada, hora utc, hora local]


{
    "data": [
        [
            227.73,
            1.45,
            172,
            13121.56,
            0,
            "2023/9/12 0:00:34",
            "2023/9/11 14:00:34"
        ],
        [
            229.43,
            1.45,
            172,
            13121.56,
            0,
            "2023/9/12 0:01:33",
            "2023/9/11 14:01:33"
        ]
    ],
    "successful": true,
    "message": null
}

Resposta: trifásico - meterdatalist

{
    "data": [
        [
            230,//tensão faseA
            0,//corrente
            0,//potência ativa
            468.41,//kWh importado
            0,//kWh exportado
            230,//FaseB
            0,
            0,
            236.58,
            290.77,
            230,//Fase C
            0,
            0,
            258.62,
            0,
            "2023/9/12 0:00:15",
            "2023/9/11 16:00:15"
        ],
        [
            230,
            0,
            0,
            468.41,
            0,
            230,
            0,
            0,
            236.58,
            290.77,
            230,
            0,
            0,
            258.62,
            0,
            "2023/9/12 0:02:08",
            "2023/9/11 16:02:08"
        ]
    ],
    "successful": true,
    "message": null
}

Resposta: trifásico - meterdatalist2

{
    "data":[
        { //primeiro dado
            "rtcTime":"2023/9/1 0:00:22",
            "gmtTime":"2023/8/31 16:00:22",
            "values":[
                [ //fase A
                    235.2,//tensão
                    0.03,//corrente
                    4,//potência ativa
                    0.57,//fator de potência
                    210.21,//kWh importado
                    0 //kWh exportado
                ],
                [//fase B
                    5.5,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [ //fase C
                    3.3,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        },
        { //segundo dado
            "rtcTime":"2023/9/1 8:00:49",
            "gmtTime":"2023/9/1 0:00:49",
            "values":[
                [
                    233.4,
                    0.03,
                    4,
                    0.57,
                    210.24,
                    0
                ],
                [
                    5.4,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [
                    3.3,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        },
        { //terceiro dado
            "rtcTime":"2023/9/1 16:00:24",
            "gmtTime":"2023/9/1 8:00:24",
            "values":[
                [
                    235.6,
                    0.03,
                    4,
                    0.57,
                    210.27,
                    0
                ],
                [
                    5.5,
                    0,
                    0,
                    0,
                    0,
                    0
                ],
                [
                    3.4,
                    0,
                    0,
                    0,
                    0,
                    0
                ]
            ]
        }
    ],
    "successful":true,
    "message":null
}

Exemplo

https://www.iammeter.com/api/v1/Site/MeterDataList/{yourSN}?token={yourToken}&startTime=2023-09-01&endTime=2023-09-07&interval=300

image-20230926150649591

Medidor de Energia: Análise de leitura de potência

Retorna o resultado da análise de potência no período especificado.

Por favor, não chame esta API mais de 5 vezes em um dia.

URL e Método

URL:https://www.iammeter.com/api/v1/site/powerAnalysis

Método: get

Limite: Por favor, não solicite esta API por SN mais de 5 vezes por dia.

Parâmetros

Nome Tipo Exemplo
sn String xxx obrigatório
startTime String 2023-09-01 opcional
endTime String 2023-09-07 opcional

Observação:

  1. O período máximo é de 7 dias no último mês.
  2. O parâmetro de tempo é opcional; se você não usar o parâmetro, a API retornará o resultado dos últimos 7 dias.

Resposta

average: leitura média de potência durante este período.

averageDaytime: leitura média de potência durante o período diurno (8:00-20:00) neste intervalo.

minimum: leitura mínima de potência durante este período.

maximum: leitura máxima de potência durante este período.

{
    "data": {
        "startTime": "2023-09-01",
        "endTime": "2023-09-07",
        "average": 862.6,
        "averageDaytime": 836.9,
        "minimum": 259.0,
        "maximum": 3999.0
    },
    "successful": true,
    "message": null
}

Exemplo

Retorna o resultado da análise de potência dos últimos 7 dias.

image-20230921163444898

Retorna o resultado da análise de potência do dia especificado

https://www.iammeter.com/api/v1/site/powerAnalysis?token={YourToken}&sn={YourSN}&starttime=2023-09-21&endtime=2023-09-21

image-20230922101047074

Medidor de Energia: Análise de status offline

Retorna o status de desconexão com o SN especificado no período determinado.

Por favor, não chame esta API mais de 5 vezes em um dia.

URL e Método

URL: https://www.iammeter.com/api/v1/site/offlineAnalysis

Método: Get

Limite: Por favor, não solicite esta API por SN mais de 5 vezes por dia.

Parâmetros

Nome Tipo Exemplo
sn String xxxx obrigatório
startTime String 2023-09-01 opcional
endTime String 2023-09-07 opcional
interval(unidade: minuto) Número 5 opcional

Observação:

  1. O período máximo é de 7 dias no último mês.
  2. O parâmetro de tempo é opcional; se você não usar o parâmetro, a API retornará o resultado dos últimos 7 dias.
  3. Se você não especificar o intervalo, o padrão é 5 minutos.

Resposta

Há um total de 10080 minutos neste período.

O tempo total offline é de 906 minutos neste período.

A lacuna offline maior que 5 minutos é listada no array.

{
    "data": {
        "startTime": "2023-09-05",
        "endTime": "2023-09-11",
        "offlineCount": 906,
        "totalCount": 10080,
        "list": [
            {
                "startTime": "2023/9/5 0:00:00",
                "endTime": "2023/9/5 15:06:14",
                "duration": 906
            }
        ]
    },
    "successful": true,
    "message": null
}

Exemplo

Retorna o resultado da análise offline do dia especificado

https://www.iammeter.com/api/v1/site/offlineAnalysis?token={YourToken}&sn={YourSN}&starttime=2023-09-21&endtime=2023-09-21

image-20230922101653639

Conta: recuperar os dados mais recentes de todos os medidores de energia em uma única conta

Retorna o valor mais recente de todos os medidores de energia nesta conta.

URL e Método

URL: https://www.iammeter.com/api/v1/site/metersdata?token=xxx

Método: Get

Limite: Certifique-se de não fazer solicitações a esta API com mais frequência do que uma vez a cada 5 minutos.

Parâmetros

Nome Tipo Exemplo
Token String xxx obrigatório

Resposta

{
    "data":[
        {
            "sn":"DA2BED94",
            "values":[
                223.71,
                1.74,
                225,
                14761.03,
                0
            ],
            "gmtTime":"2024/2/22 3:46:20"
        },
        {
            "sn":"B384789C",
            "values":[
                [
                    248.9,
                    13.9,
                    3356,
                    21228,
                    0,
                    null,
                    null
                ],
                [
                    248.9,
                    13.9,
                    -2747,
                    8988.48,
                    18489.44,
                    null,
                    null
                ],
                [
                    null,
                    null,
                    null,
                    null,
                    null,
                    null,
                    null
                ],
                [
                    248.9,
                    13.9,
                    -2747,
                    8988.48,
                    18489.44,
                    null,
                    null
                ]
            ],
            "gmtTime":"2024/2/22 3:45:15"
        },
        {
            "sn":"674B1E5D",
            "values":[
                [
                    220.4,
                    1.86,
                    377,
                    5345.985,
                    20.565
                ],
                [
                    220.4,
                    1.86,
                    377,
                    5367.715,
                    0.033
                ],
                [
                    220.5,
                    1.86,
                    377,
                    5369.532,
                    0.033
                ]
            ],
            "gmtTime":"2024/2/22 3:45:50"
        },
        {
            "sn":"59C9AB8D",
            "values":[
                [
                    245.3,
                    6.5,
                    1604,
                    46055.7,
                    0,
                    null,
                    null
                ],
                [
                    245.3,
                    6.5,
                    -910,
                    15726.73,
                    8956.56,
                    null,
                    null
                ],
                [
                    null,
                    null,
                    null,
                    null,
                    null,
                    null,
                    null
                ],
                [
                    245.3,
                    6.5,
                    -910,
                    15726.73,
                    8956.56,
                    null,
                    null
                ]
            ],
            "gmtTime":"2024/2/22 3:45:15"
        },
        {
            "sn":"3FE34ABE",
            "values":[
                [
                    230,
                    15.9,
                    3650.1,
                    2704.35,
                    0,
                    49.99,
                    0.94
                ],
                [
                    230,
                    -11.5,
                    -2650.1,
                    1411.31,
                    1722.35,
                    49.99,
                    0.94
                ],
                [
                    230,
                    4.3,
                    1000,
                    1946.03,
                    0,
                    49.99,
                    0.94
                ]
            ],
            "gmtTime":"2024/2/22 3:46:01"
        }
    ],
    "successful":true,
    "message":null
}

Exemplo

image-20240222114848312

Local: Retornar os dados horários ou diários de kWh para cada tipo de uso

Recupere os valores horários/diários de kWh para geração do inversor e troca com a rede (exportado e importado)

URL e Método

URL: https://www.iammeter.com/api/v1/site/energyhistory/{place_ID}?**startTime**={2024-05-05}&**endTime**={2024-07-07}&**groupby**={day}&**Token**={2be6d1xxxxxxcc688}

Método: get

Limite:

groupby = day: 90 dias de dados (90 registros)

groupby = hour: 7 dias de dados (168 registros)

Parâmetros

Nome Tipo Descrição Exemplo
Token String token da conta xxx obrigatório
place_ID number ID do local obrigatório
startTime string hora de início do retorno desta api 2023-09-01 obrigatório
endTime string hora de término do retorno desta api 2023-09-07 obrigatório
groupby enum selecionar intervalo de dados retornados (hora/dia) day/hour obrigatório

place_ID: Meus Locais->Editar

place_id

Resposta: monofásico

place_id:1360

startTime=2024-05-05

endTime=2024-05-07

groupby=day

https://www.iammeter.com/api/v1/site/energyhistory/1360?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
    "data": [{
            "time": "2024/5/5 0:00:00",
            "yield": 0,
            "fromGrid": 9.62,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/6 0:00:00",
            "yield": 0,
            "fromGrid": 9.16,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        }
    ],
    "successful": true,
    "message": null
}

Resposta: trifásico

place_id:2393

startTime=2024-05-05

endTime=2024-05-07

groupby=day

https://www.iammeter.com/api/v1/site/energyhistory/2393?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
    "data": [{
            "time": "2024/5/5 0:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/6 0:00:00",
            "yield": 0.1,
            "fromGrid": 0.22,
            "toGrid": 7.15,
            "specialLoad": 0,
            "selfUse": 0
        }
    ],
    "successful": true,
    "message": null
}

place_id:2393

startTime=2024-05-05

endTime=2024-05-06

groupby=hour

https://www.iammeter.com/api/v1/site/energyhistory/2393?startTime=2024-05-05&endTime=2024-05-07&groupby=day&Token=f7eba1ac8c194b3fbc8e79b8af0adb72

{
    "data": [{
            "time": "2024/5/5 0:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 1:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 2:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 3:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 4:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 5:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 6:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 7:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 8:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 9:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 10:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 11:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 12:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 13:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 14:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 15:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 16:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 17:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 18:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 19:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 20:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 21:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 22:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        },
        {
            "time": "2024/5/5 23:00:00",
            "yield": 0,
            "fromGrid": 0,
            "toGrid": 0,
            "specialLoad": 0,
            "selfUse": 0
        }
    ],
    "successful": true,
    "message": null
}

Referência

API do Medidor de Energia WiFi

Quais recursos a IAMMETER oferece?

Qual tipo de medidor elétrico melhor atende às suas necessidades?

Como encontrar o medidor de energia adequado às suas necessidades

Use o medidor de energia trifásico da maneira que preferir

Medidor de Energia WiFi trifásico

Topo