Documentação da API v1

API do Gestor Notifique e da ativação de apps. Uma chave pn_ por integração: idfire e authkey nunca saem do servidor. Clientes e servidores de outro vendedor não são alcançados (404). Todo erro vem com "sucesso": false e a mensagem em "erro". Exemplos de resposta capturados do ambiente real, com dados mascarados.

URL Base de Produção https://apiv1.notifique.net/v1

Autenticação

Crie a chave no Painel Notifique, na tela de chaves da API. Ela começa com pn_, aparece uma única vez e pode ser revogada a qualquer momento (até 5 chaves ativas). Não coloque a chave em site ou app público: use no seu servidor.

Authorization: Bearer pn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Também aceito: X-API-Key: pn_....

Erros e limites

Todo erro vem com "sucesso": false e a mensagem em erro. Exemplo:

{
    "sucesso": false,
    "erro": "Chave da API ausente ou inválida. Envie no cabeçalho Authorization: Bearer pn_..."
}
400Campo obrigatório ausente ou inválido (a mensagem diz qual).
401Chave ausente, inválida ou revogada.
404Cliente ou servidor não encontrado para esta chave (ou de outro vendedor).
429Limite de requisições por minuto excedido.
502O sistema recusou a solicitação.
504O sistema demorou a responder. Tente de novo.

Postman, IA e OpenAPI

Servidores

Servidores (painéis IPTV) do vendedor.

GET /servidores

Listar servidores

Lista os servidores do vendedor da chave, com o id usado nas outras rotas. Login e senha do painel IPTV nunca são devolvidos.

curl "https://apiv1.notifique.net/v1/servidores" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "sucesso": true,
    "servidores": [
        {
            "id": 204,
            "nome": "S*** M***",
            "tipo": "outros",
            "dns": "https://XXXXXX",
            "dns2": "https://XXXXXX",
            "renovacao_automatica": false,
            "valores": {
                "mensal": 35,
                "bimestral": 70,
                "trimestral": 90,
                "semestral": 150,
                "anual": 300
            }
        },
        {
            "id": 568,
            "nome": "F***",
            "tipo": "painel Foda",
            "dns": "https://XXXXXX",
            "dns2": "https://XXXXXX",
            "renovacao_automatica": true,
            "valores": {
                "mensal": 35,
                "bimestral": 70,
                "trimestral": 90,
                "semestral": 140,
                "anual": 200
            }
        }
    ]
}
{
    "sucesso": false,
    "erro": "Chave da API ausente ou inválida. Envie no cabeçalho Authorization: Bearer pn_..."
}
{
    "sucesso": false,
    "erro": "Chave da API inválida ou revogada."
}

Clientes

Clientes do gestor: busca, teste, edição, renovação, sincronização, subclientes e exclusão.

GET /clientes

Buscar cliente

Busca pelo WhatsApp ou pelo idBanco. Só encontra clientes do vendedor da chave. Sem cadastro: 200 com "cliente": false.

Parâmetros

whats (query)DDI+DDD+número. Obrigatório se não enviar id.
id (query)idBanco do cliente. Obrigatório se não enviar whats.
curl "https://apiv1.notifique.net/v1/clientes?whats=5511999990000" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "sucesso": true,
    "mensagem": "edit",
    "cliente": true,
    "link_pagamento": "https://pagzap.online/XXXXXX",
    "idBanco": 584106,
    "data": "05/11/2026",
    "enviou": false,
    "whats": "(11************",
    "idFire": "f0i*************************",
    "userid": "135****",
    "nome": "T*** D***",
    "instancia": "HJV*****",
    "vencimento": "07/11/2026",
    "login": "712*******",
    "vendedor": "ftv***",
    "arquivado": false,
    "userTeste": true,
    "linkPagamento": "https://pagzap.online/XXXXXX",
    "valorPadrao": false,
    "mensal": "0",
    "bimestral": "0",
    "trimestral": "0",
    "semestral": "0",
    "anual": "0",
    "dataEnvio": null,
    "whatsBR": true,
    "cron1": false,
    "cron2": false,
    "cron3": true,
    "cron5": true,
    "alert1": false,
    "alert2": true,
    "alert15": false,
    "alert30": false,
    "senha": "304*******",
    "idSigma": null,
    "idServidor": 114,
    "nota": "Teste Auto - Gestor",
    "cronVencimento": false,
    "ativo": true,
    "email": null,
    "cobrarEmail": false
}
{
    "sucesso": true,
    "mensagem": "edit",
    "cliente": true,
    "link_pagamento": "https://pagzap.online/XXXXXX",
    "idBanco": 584106,
    "data": "05/11/2026",
    "enviou": false,
    "whats": "(11************",
    "idFire": "f0i*************************",
    "userid": "135****",
    "nome": "T*** D***",
    "instancia": "HJV*****",
    "vencimento": "07/11/2026",
    "login": "712*******",
    "vendedor": "ftv***",
    "arquivado": false,
    "userTeste": true,
    "linkPagamento": "https://pagzap.online/XXXXXX",
    "valorPadrao": false,
    "mensal": "0",
    "bimestral": "0",
    "trimestral": "0",
    "semestral": "0",
    "anual": "0",
    "dataEnvio": null,
    "whatsBR": true,
    "cron1": false,
    "cron2": false,
    "cron3": true,
    "cron5": true,
    "alert1": false,
    "alert2": true,
    "alert15": false,
    "alert30": false,
    "senha": "304*******",
    "idSigma": null,
    "idServidor": 114,
    "nota": "Teste Auto - Gestor",
    "cronVencimento": false,
    "ativo": true,
    "email": null,
    "cobrarEmail": false,
    "subClients": []
}
{
    "sucesso": true,
    "cliente": false,
    "mensagem": "Whatsapp sem cadastro."
}
{
    "sucesso": false,
    "erro": "Informe whats (DDI+DDD+número) ou id (idBanco)."
}
POST /clientes/teste

Criar teste automático

Cria o cliente de teste no painel IPTV e no gestor. Com valorPadrao=false, informe os valores avulsos; com datasPadrao=false, as datas de aviso.

Corpo (JSON)

whatsCliente *string DDI+DDD+número
nomeClientestring
idServidor *integer id de GET /servidores
valorPadraoboolean true = valores do servidor
valor_mensalnumber
valor_bimestralnumber
valor_trimestralnumber
valor_semestralnumber
valor_anualnumber
datasPadraoboolean true = dias de aviso padrão do vendedor
5antesboolean
3antesboolean
2antesboolean
1antesboolean
noDiaboolean
1depoisboolean
5depoisboolean
15depoisboolean
30depoisboolean
curl -X POST "https://apiv1.notifique.net/v1/clientes/teste" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "whatsCliente": "5511977149078",
    "nomeCliente": "Teste Documentacao",
    "idServidor": 114,
    "valorPadrao": true,
    "datasPadrao": true
}'
{
    "id_banco": 584106,
    "data": "05/11/2026",
    "enviou": false,
    "whats": "(11************",
    "idfire": "f0i*************************",
    "userid": "135****",
    "nome": "T*** D***",
    "instancia": "HJV*****",
    "vencimento": "07/11/2026",
    "mensagem": "Sucesso ao gerar teste.",
    "login": "712*******",
    "vendedor": "ftv***",
    "arquivado": false,
    "user_teste": true,
    "link_pagamento": "https://pagzap.online/XXXXXX",
    "valor_padrao": false,
    "mensal": "0",
    "bimestral": "0",
    "trimestral": "0",
    "semestral": "0",
    "anual": "0",
    "data_envio": null,
    "whats_br": true,
    "cron1": false,
    "cron2": false,
    "cron3": true,
    "cron5": true,
    "alert1": false,
    "alert2": true,
    "alert15": false,
    "alert30": false,
    "senha": "304*******",
    "id_sigma": null,
    "idServidor": 114,
    "nota": "Teste Auto - Gestor",
    "cronVencimento": false,
    "ativo": true,
    "horaenvio": "08:00",
    "email": null,
    "cobrarEmail": false,
    "sucesso": true
}
{
    "sucesso": false,
    "erro": "whatsCliente é obrigatório."
}
{
    "sucesso": false,
    "erro": "Servidor não encontrado para esta chave."
}
PATCH /clientes/{id}

Atualizar cliente

Ligue as flags editar_* do que quiser mudar e mande os valores em informacoes. sincronizar=true sincroniza com o painel depois.

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).

Corpo (JSON)

editar_valorboolean
editar_nomeboolean
editar_whatsappboolean
editar_vencimentoboolean
editar_notaboolean
editar_emailboolean
editar_loginboolean
editar_senhaboolean
sincronizarboolean
informacoesobject
curl -X PATCH "https://apiv1.notifique.net/v1/clientes/12345" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "editar_nota": true,
    "informacoes": {
        "nota": "editado pela API"
    }
}'
{
    "idBanco": 584106,
    "data": "05/11/2026",
    "enviou": false,
    "whats": "(11************",
    "idFire": "f0i*************************",
    "userid": "135****",
    "nome": "T*** D***",
    "instancia": "HJV*****",
    "vencimento": "07/11/2026",
    "mensagem": "edit",
    "login": "712*******",
    "vendedor": "ftv***",
    "arquivado": false,
    "userTeste": true,
    "linkPagamento": "https://pagzap.online/XXXXXX",
    "valorPadrao": false,
    "mensal": "0",
    "bimestral": "0",
    "trimestral": "0",
    "semestral": "0",
    "anual": "0",
    "dataEnvio": null,
    "whatsBR": true,
    "cron1": false,
    "cron2": false,
    "cron3": true,
    "cron5": true,
    "alert1": false,
    "alert2": true,
    "alert15": false,
    "alert30": false,
    "senha": "304*******",
    "idSigma": null,
    "idServidor": 114,
    "nota": "editado pela API",
    "cronVencimento": false,
    "ativo": true,
    "email": null,
    "cobrarEmail": false,
    "sucesso": true,
    "resposta": "cliente atualizado com sucesso."
}
{
    "sucesso": false,
    "erro": "Nada para atualizar. Veja os campos editar_* e informacoes."
}
{
    "sucesso": false,
    "erro": "Cliente não encontrado para esta chave."
}
DELETE /clientes/{id}

Deletar cliente

Remove o cliente do gestor. Não pode ser desfeito: exige ?confirmar=true.

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).
confirmar * (query)precisa ser true
curl -X DELETE "https://apiv1.notifique.net/v1/clientes/12345?confirmar=true" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "message": "ok"
}
{
    "sucesso": false,
    "erro": "Para deletar, envie ?confirmar=true. A exclusão não pode ser desfeita."
}
{
    "sucesso": false,
    "erro": "Cliente não encontrado para esta chave."
}
POST /clientes/{id}/renovar

Renovar no painel

Renova no painel IPTV do servidor do cliente, como o botão Renovar do gestor. CONSOME CRÉDITO DO PAINEL. O tipo do painel e o servidor são descobertos pela API.

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).

Corpo (JSON)

meses *integer (1, 2, 3, 6, 12)
valor_pago *number
telasinteger 0 = manter a quantidade atual
curl -X POST "https://apiv1.notifique.net/v1/clientes/12345/renovar" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "meses": 1,
    "valor_pago": 30,
    "telas": 0
}'
{
    "sucesso": false,
    "erro": "meses deve ser um destes: 1, 2, 3, 6, 12."
}
{
    "sucesso": false,
    "erro": "valor_pago inválido."
}
{
    "sucesso": false,
    "erro": "Cliente não encontrado para esta chave."
}
POST /clientes/{id}/sincronizar

Sincronizar com o painel

Puxa do painel IPTV os dados atuais do cliente (vencimento, login, telas) e atualiza o gestor. Sem corpo.

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).
curl -X POST "https://apiv1.notifique.net/v1/clientes/12345/sincronizar" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "resposta": "ok"
}
{
    "sucesso": false,
    "erro": "Cliente não encontrado para esta chave."
}
POST /clientes/{id}/subclientes

Adicionar subcliente

Importa a conta do painel pelo login e liga ao cliente {id}. Sem servidor_id usa o servidor do cliente pai.

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).

Corpo (JSON)

login *string usuário da conta no painel IPTV
servidor_idinteger outro servidor do vendedor (opcional)
notastring
curl -X POST "https://apiv1.notifique.net/v1/clientes/12345/subclientes" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "login": "712*******",
    "nota": "TV do quarto"
}'
{
    "resposta": "ok"
}
{
    "sucesso": false,
    "erro": "login é obrigatório (o usuário da conta no painel IPTV)."
}
{
    "sucesso": false,
    "erro": "Conta não encontrada no painel com esse login."
}
{
    "sucesso": false,
    "erro": "Servidor não encontrado para esta chave."
}

Pacotes por tela

Valores por quantidade de telas (1 a 4). Disponível nos servidores The Best e PlayFast.

PUT /servidores/{id}/pacotes

Pacotes do servidor

Valores por quantidade de telas do servidor (The Best ou PlayFast).

Parâmetros

id * (path)id do servidor (vem em GET /servidores).

Corpo (JSON)

valorPadraoboolean
mensal1number mensal, 1 tela(s); 0 desativa
mensal2number mensal, 2 tela(s); 0 desativa
mensal3number mensal, 3 tela(s); 0 desativa
mensal4number mensal, 4 tela(s); 0 desativa
bimestral1number bimestral, 1 tela(s); 0 desativa
bimestral2number bimestral, 2 tela(s); 0 desativa
bimestral3number bimestral, 3 tela(s); 0 desativa
bimestral4number bimestral, 4 tela(s); 0 desativa
trimestral1number trimestral, 1 tela(s); 0 desativa
trimestral2number trimestral, 2 tela(s); 0 desativa
trimestral3number trimestral, 3 tela(s); 0 desativa
trimestral4number trimestral, 4 tela(s); 0 desativa
semestral1number semestral, 1 tela(s); 0 desativa
semestral2number semestral, 2 tela(s); 0 desativa
semestral3number semestral, 3 tela(s); 0 desativa
semestral4number semestral, 4 tela(s); 0 desativa
anual1number anual, 1 tela(s); 0 desativa
anual2number anual, 2 tela(s); 0 desativa
anual3number anual, 3 tela(s); 0 desativa
anual4number anual, 4 tela(s); 0 desativa
curl -X PUT "https://apiv1.notifique.net/v1/servidores/12345/pacotes" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "sucesso": false,
    "erro": "Servidor não encontrado para esta chave."
}
PUT /clientes/{id}/pacotes

Pacotes do cliente

Valores por quantidade de telas só para este cliente (servidor The Best ou PlayFast).

Parâmetros

id * (path)idBanco do cliente (vem em GET /clientes).

Corpo (JSON)

valorPadraoboolean
mensal1number mensal, 1 tela(s); 0 desativa
mensal2number mensal, 2 tela(s); 0 desativa
mensal3number mensal, 3 tela(s); 0 desativa
mensal4number mensal, 4 tela(s); 0 desativa
bimestral1number bimestral, 1 tela(s); 0 desativa
bimestral2number bimestral, 2 tela(s); 0 desativa
bimestral3number bimestral, 3 tela(s); 0 desativa
bimestral4number bimestral, 4 tela(s); 0 desativa
trimestral1number trimestral, 1 tela(s); 0 desativa
trimestral2number trimestral, 2 tela(s); 0 desativa
trimestral3number trimestral, 3 tela(s); 0 desativa
trimestral4number trimestral, 4 tela(s); 0 desativa
semestral1number semestral, 1 tela(s); 0 desativa
semestral2number semestral, 2 tela(s); 0 desativa
semestral3number semestral, 3 tela(s); 0 desativa
semestral4number semestral, 4 tela(s); 0 desativa
anual1number anual, 1 tela(s); 0 desativa
anual2number anual, 2 tela(s); 0 desativa
anual3number anual, 3 tela(s); 0 desativa
anual4number anual, 4 tela(s); 0 desativa
curl -X PUT "https://apiv1.notifique.net/v1/clientes/12345/pacotes" \
  -H "Authorization: Bearer pn_SUA_CHAVE"
{
    "sucesso": false,
    "erro": "Cliente não encontrado para esta chave."
}

Ativação de apps

Ativação de apps por MAC (já existente).

GET /apps

Apps disponíveis

Apps disponíveis para o vendedor, com o idapp usado na ativação.

curl "https://apiv1.notifique.net/v1/apps" \
  -H "Authorization: Bearer pn_SUA_CHAVE"

Resposta conforme os dados do seu cadastro. Erros: veja Erros e limites.

GET /carteira

Carteira

Créditos, ativados e com erro.

curl "https://apiv1.notifique.net/v1/carteira" \
  -H "Authorization: Bearer pn_SUA_CHAVE"

Resposta conforme os dados do seu cadastro. Erros: veja Erros e limites.

GET /macs

Listar MACs

Lista de MACs ativados; busca filtra por fragmento do MAC (até 50 por página).

Parâmetros

pg (query)
erro (query)true = só os com erro
busca (query)fragmento do MAC
curl "https://apiv1.notifique.net/v1/macs?pg=1" \
  -H "Authorization: Bearer pn_SUA_CHAVE"

Resposta conforme os dados do seu cadastro. Erros: veja Erros e limites.

POST /ativacoes

Ativar app

Solicita a ativação de um app para um MAC. mac aceita com ou sem separador; appkey é a chave de ativação do app.

Corpo (JSON)

idapp *string de GET /apps
mac *string
appkey *string chave de ativação do app
whatsappstring
notificarboolean
curl -X POST "https://apiv1.notifique.net/v1/ativacoes" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "idapp": "ID_DO_APP",
    "mac": "AA:BB:CC:DD:EE:FF",
    "appkey": "123456",
    "whatsapp": "5511999990000",
    "notificar": false
}'

Resposta conforme os dados do seu cadastro. Erros: veja Erros e limites.

POST /ativacoes/{idpag}/reenviar

Reenviar ativação

Reenvia uma ativação que ficou com erro (idpag vem de GET /macs?erro=true).

Parâmetros

idpag * (path)

Corpo (JSON)

mac *string
appkey *string
curl -X POST "https://apiv1.notifique.net/v1/ativacoes/IDPAG/reenviar" \
  -H "Authorization: Bearer pn_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "mac": "AA:BB:CC:DD:EE:FF",
    "appkey": "123456"
}'

Resposta conforme os dados do seu cadastro. Erros: veja Erros e limites.

Conheça também nossa base de apoio
Guia com tutoriais passo a passo do Gestor Notifique.
Abrir o guia