Assinantes
GET /subscribers/internet_speedsCopied!
Este endpoint retorna uma lista de todas as velocidades de internet disponíveis para seleção durante o cadastro/atualização de assinante. Utilize o ID correspondente à velocidade para tal.
Exemplo de lista de velocidades de internet:
{
"internet_speeds": [
{
"id": 1,
"speed": "10 Mbps",
"slug": "10mbps"
},
{
"id": 2,
"speed": "20 Mbps",
"slug": "20mbps"
},
{
"id": 3,
"speed": "30 Mbps",
"slug": "30mbps"
},
{
"id": 4,
"speed": "40 Mbps",
"slug": "40mbps"
},
{
"id": 5,
"speed": "50 Mbps",
"slug": "50mbps"
},
{
"id": 6,
"speed": "60 Mbps",
"slug": "60mbps"
},
{
"id": 7,
"speed": "70 Mbps",
"slug": "70mbps"
},
{
"id": 8,
"speed": "80 Mbps",
"slug": "80mbps"
},
{
"id": 9,
"speed": "90 Mbps",
"slug": "90mbps"
},
{
"id": 10,
"speed": "100 Mbps",
"slug": "100mbps"
},
{
"id": 11,
"speed": "110 Mbps",
"slug": "110mbps"
},
{
"id": 12,
"speed": "120 Mbps",
"slug": "120mbps"
},
{
"id": 13,
"speed": "130 Mbps",
"slug": "130mbps"
},
{
"id": 14,
"speed": "140 Mbps",
"slug": "140mbps"
},
{
"id": 15,
"speed": "150 Mbps",
"slug": "150mbps"
},
{
"id": 16,
"speed": "160 Mbps",
"slug": "160mbps"
},
{
"id": 17,
"speed": "170 Mbps",
"slug": "170mbps"
},
{
"id": 18,
"speed": "180 Mbps",
"slug": "180mbps"
},
{
"id": 19,
"speed": "190 Mbps",
"slug": "190mbps"
},
{
"id": 20,
"speed": "200 Mbps",
"slug": "200mbps"
},
{
"id": 21,
"speed": "250 Mbps",
"slug": "250mbps"
},
{
"id": 22,
"speed": "300 Mbps",
"slug": "300mbps"
},
{
"id": 23,
"speed": "350 Mbps",
"slug": "350mbps"
},
{
"id": 24,
"speed": "400 Mbps",
"slug": "400mbps"
},
{
"id": 25,
"speed": "450 Mbps",
"slug": "450mbps"
},
{
"id": 26,
"speed": "500 Mbps",
"slug": "500mbps"
},
{
"id": 27,
"speed": "550 Mbps",
"slug": "550mbps"
},
{
"id": 28,
"speed": "600 Mbps",
"slug": "600mbps"
},
{
"id": 29,
"speed": "650 Mbps",
"slug": "650mbps"
},
{
"id": 30,
"speed": "700 Mbps",
"slug": "700mbps"
},
{
"id": 31,
"speed": "750 Mbps",
"slug": "750mbps"
},
{
"id": 32,
"speed": "800 Mbps",
"slug": "800mbps"
},
{
"id": 33,
"speed": "850 Mbps",
"slug": "850mbps"
},
{
"id": 34,
"speed": "900 Mbps",
"slug": "900mbps"
},
{
"id": 35,
"speed": "950 Mbps",
"slug": "950mbps"
},
{
"id": 36,
"speed": "1000 Mbps",
"slug": "1000mbps"
},
{
"id": 37,
"speed": "5Mbps",
"slug": "5mbps"
},
{
"id": 38,
"speed": "Não informado",
"slug": "Não informado"
}
],
"response": "success"
}POST /subscribersCopied!
Este endpoint permite que novos assinantes sejam cadastrados.
O payload deve estar no seguinte formato:
{
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps"
}POST /subscribers/importCopied!
Este endpoint possibilita o cadastro de assinantes e a ativação de serviços em larga escala. Em outras palavras, é possível cadastrar um ou mais assinantes e indicar quais serviços devem ser ativados para cada um deles. Os IDs dos serviços devem ser inseridos no array "products_ids"
O payload deve estar no seguinte formato:
{
"subscribers": [
{
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps",
"products_ids" : [1]
},
{
"email": "kaue.alexandre.brito@gustavoscoelho.com.br",
"name": "Kauê Alexandre Brito",
"document": "592.918.520-40",
"phone": "+5521982217775",
"internet_speed_id": 2,
"customer_plan": "Plano Globoplay 10Mbps",
"products_ids" : [2, 3]
}
]
}O objetivo deste endpoint é cadastrar assinantes e ativar serviços, logo, a ativação de serviços é exclusiva para assinantes que estão sendo cadastrados (ainda não estão em nossa base de dados). Para ativar ou alterar serviços de assinantes cadastrados é necessário usar os endpoints de provisionamento.
GET /subscribersCopied!
Este endpoint retorna uma lista de todos os assinantes cadastrados do provedor, fornecendo uma visão geral.
Exemplo:
{
"subscribers": [
{
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps",
"services": [
{
"content_supplier_product_name": "Globoplay",
"content_supplier_product_code": "globoplay",
"content_supplier_product_id": 1,
"status_id": 1,
"status": "active"
}
]
},
{
"email": "walker.jeanie@example.net",
"name": "Walker Jeanie",
"document": "89907446017",
"phone": "+5526849068464",
"internet_speed_id": 1,
"customer_plan": "",
"services": []
}
],
"response": "success"
}GET /subscribers/{document}Copied!
Este endpoint retorna os detalhes de um assinante específico com base no documento (CPF) fornecido.
Exemplo:
{
"subscriber": {
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps",
"services": [
{
"content_supplier_product_name": "Globoplay",
"content_supplier_product_code": "globoplay",
"content_supplier_product_id": 1,
"status_id": 1,
"status": "active"
}
]
},
"response": "success"
}GET /subscribers/search/{searchValue}Copied!
Este endpoint pesquisa assinantes com base em diferentes critérios, como nome, e-mail, documento ou telefone.
Exemplo do retorno de uma pesquisa:
{
"subscribers": [
{
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps",
"services": [
{
"content_supplier_product_name": "Globoplay",
"content_supplier_product_code": "globoplay",
"content_supplier_product_id": 1,
"status_id": 1,
"status": "active"
}
]
},
{
"email": "walker.jeanie@example.net",
"name": "Walker Jeanie",
"document": "89907446017",
"phone": "+5526849068464",
"internet_speed_id": 1,
"customer_plan": "",
"services": []
}
],
"response": "success"
}PUT /subscribers/{document}Copied!
Este endpoint permite que a atualização de um assinante cadastrado. O usuário pode modificar qualquer um dos dados. O documento do assinante deve ser fornecido para identificar o usuário a ser atualizado.
O payload deve estar no seguinte formato:
{
"email": "corey.taylor@mail.com",
"name": "Corey Taylor",
"document": "92780461080",
"phone": "+5521982217775",
"internet_speed_id": 1,
"customer_plan": "Plano Globoplay 10Mbps"
}DELETE/subscribers/{document}Copied!
Este endpoint permite que um assinante seja deletado. O usuário pode deletar qualquer assinante desde que ele não tenha serviços ou que todos os serviços dele estejam cancelados. O documento do assinante deve ser fornecido para identificá-lo.