Guia

Assinantes

Use estes endpoints para cadastrar, consultar, atualizar e remover os assinantes do seu provedor, e também para reenviar o e-mail de ativação de serviços.

ℹ️

Listagens grandes

Os endpoints de listagem e pesquisa aceitam o parâmetro paginate=S para retornar os resultados paginados. Veja como funciona em Paginação.

Campos do assinante

CampoTipoDescrição
namestringNome.
emailstringE-mail.
documentstringCPF.
phonestringTelefone com DDD.
internet_speed_idintegerID da velocidade de internet contratada. Consulte a lista em Velocidades de internet.
customer_planstringNome do plano contratado pelo assinante.

Velocidades de internet

GET /subscribers/internet_speeds

Retorna as velocidades de internet disponíveis. Use o id da velocidade no campo internet_speed_id ao cadastrar ou atualizar um assinante.

📖

Paginação

Disponível com paginate=S.

Exemplo de resposta:

{
    "internet_speeds": [
        {
            "id": 1,
            "speed": "10 Mbps",
            "slug": "10mbps"
        },
        {
            "id": 2,
            "speed": "20 Mbps",
            "slug": "20mbps"
        },
        {
            "id": 38,
            "speed": "Não informado",
            "slug": "Não informado"
        }
    ],
    "response": "success"
}
ℹ️

Consulte sempre o endpoint

Use a resposta do endpoint como fonte oficial dos IDs. A lista pode receber novas velocidades.

Cadastrar assinante

POST /subscribers

Cadastra um novo assinante.

Exemplo de payload:

{
    "email": "[email protected]",
    "name": "Corey Taylor",
    "document": "92780461080",
    "phone": "+5521982217775",
    "internet_speed_id": 1,
    "customer_plan": "Plano Globoplay 10Mbps"
}

Importar assinantes

POST /subscribers/import

Cadastra vários assinantes e ativa serviços para cada um deles em uma única requisição. Informe os IDs dos serviços a ativar no array products_ids.

Exemplo de payload:

{
    "subscribers": [
        {
            "email": "[email protected]",
            "name": "Corey Taylor",
            "document": "92780461080",
            "phone": "+5521982217775",
            "internet_speed_id": 1,
            "customer_plan": "Plano Globoplay 10Mbps",
            "products_ids": [
                1
            ]
        },
        {
            "email": "[email protected]",
            "name": "Marilyn Manson",
            "document": "59291852040",
            "phone": "+5521982217775",
            "internet_speed_id": 2,
            "customer_plan": "Plano Globoplay 20Mbps",
            "products_ids": [
                2,
                3
            ]
        }
    ]
}
⚠️

Somente para novos assinantes

A ativação de serviços por este endpoint vale apenas para assinantes que ainda não existem na nossa base. Para ativar ou alterar serviços de assinantes já cadastrados, use os endpoints de Provisionamento.

Listar assinantes

GET /subscribers

Retorna todos os assinantes do provedor, com os serviços de cada um.

📖

Paginação

Disponível com paginate=S.

Exemplo de resposta:

{
    "subscribers": [
        {
            "email": "[email protected]",
            "name": "Corey Taylor",
            "document": "92780461080",
            "phone": "+5521982217775",
            "internet_speed_id": 1,
            "created_at": "2022-06-16T03:00:00.000000Z",
            "customer_plan": "Plano Globoplay 10Mbps",
            "services": [
                {
                    "token_created_at": "2025-06-02T16:55:37.000000Z",
                    "content_supplier_product_name": "Globoplay",
                    "content_supplier_product_code": "globoplay",
                    "content_supplier_product_id": 1,
                    "status_updated_at": "2022-06-16T03:00:00.000000Z",
                    "status_id": 1,
                    "status": "active"
                }
            ]
        },
        {
            "email": "[email protected]",
            "name": "Marilyn Manson",
            "document": "98765432100",
            "phone": "+5511987651234",
            "internet_speed_id": 3,
            "created_at": "2022-06-16T03:00:00.000000Z",
            "customer_plan": "Plano Globoplay 30Mbps",
            "services": []
        }
    ],
    "response": "success"
}

Consultar assinante

GET /subscribers/{document}

Retorna os dados de um assinante específico, identificado pelo CPF informado na URL.

Exemplo de resposta:

{
    "subscriber": {
        "email": "[email protected]",
        "name": "Corey Taylor",
        "document": "92780461080",
        "phone": "+5521982217775",
        "internet_speed_id": 1,
        "created_at": "2025-06-23T03:00:00.000000Z",
        "customer_plan": "Plano Globoplay 10Mbps",
        "services": [
            {
                "token_created_at": "2025-06-23T03:00:00.000000Z",
                "content_supplier_product_name": "Globoplay",
                "content_supplier_product_code": "globoplay",
                "content_supplier_product_id": 1,
                "status_updated_at": "2025-06-23T03:00:00.000000Z",
                "status_id": 1,
                "status": "active"
            }
        ]
    },
    "response": "success"
}

Pesquisar assinantes

GET /subscribers/search/{searchValue}

Pesquisa assinantes por nome, e-mail, documento ou telefone. Informe o termo de busca no lugar de searchValue.

📖

Paginação

Disponível com paginate=S.

Exemplo de resposta:

{
    "subscribers": [
        {
            "email": "[email protected]",
            "name": "Corey Taylor",
            "document": "92780461080",
            "phone": "+5521982217775",
            "internet_speed_id": 1,
            "created_at": "2025-06-23T03:00:00.000000Z",
            "customer_plan": "Plano Globoplay 10Mbps",
            "services": [
                {
                    "token_created_at": "2025-06-23T03:00:00.000000Z",
                    "content_supplier_product_name": "Globoplay",
                    "content_supplier_product_code": "globoplay",
                    "content_supplier_product_id": 1,
                    "status_updated_at": "2025-06-23T03:00:00.000000Z",
                    "status_id": 1,
                    "status": "active"
                }
            ]
        },
        {
            "email": "[email protected]",
            "name": "Marilyn Manson",
            "document": "89907446017",
            "phone": "+5526849068464",
            "internet_speed_id": 1,
            "created_at": "2025-06-23T03:00:00.000000Z",
            "customer_plan": "",
            "services": []
        }
    ],
    "response": "success"
}

Atualizar assinante

PUT /subscribers/{document}

Atualiza os dados de um assinante já cadastrado. O campo document na URL identifica o assinante, e você pode alterar qualquer um dos campos.

Exemplo de payload:

{
    "email": "[email protected]",
    "name": "Corey Taylor",
    "document": "92780461080",
    "phone": "+5521982217775",
    "internet_speed_id": 1,
    "customer_plan": "Plano Globoplay 10Mbps"
}
❗

Atualização de e-mail

A alteração de e-mail do assinante dispara o reenvio do e-mail de ativação!

Excluir assinante

DELETE /subscribers/{document}

Remove um assinante, identificado pelo campo document informado na URL.

⚠️

Quando é possível excluir?

A exclusão só é permitida se o assinante não tiver serviços ou se todos os serviços dele estiverem cancelados.

Reenviar e-mail de ativação

POST /subscribers/resend_activation_email

Reenvia o e-mail de ativação para todos os tokens do assinante. O assinante recebe um novo e-mail com o link de ativação para cada token.

Se o provedor tiver uma callback de ativação cadastrada, ela também é acionada para esses tokens. A callback envia os dados atuais do assinante, as informações do serviço e a URL de ativação.

Use este endpoint quando o assinante:

  • não recebeu o e-mail de ativação original;
  • excluiu o e-mail por engano.

Exemplo de payload:

{
    "document": "92780461080"
}
❗

O link anterior deixa de funcionar

Ao reenviar o e-mail, o link de ativação enviado antes é invalidado.



Updated about 11 hours ago

Did this page help you?