Produtos

Use estes endpoints para consultar os produtos (serviços) que o provedor pode oferecer aos assinantes e os status que cada um pode assumir.

ℹ️
Listagens grandes
Os dois endpoints aceitam o parâmetro paginate=S para retornar os resultados paginados. Veja como funciona em Paginação.

Listar produtos

GET /products

Retorna todos os produtos que o provedor pode comercializar para seus assinantes. Além dos dados básicos, cada produto traz:

Campos do produto

Campo	Tipo	Descrição
`id`	integer	Identificador.
`name`	string	Nome.
`code`	string	Código.
`active`	boolean	Indica se o produto está ativo ou não.
`can`	array	Ações permitidas para o produto (veja a tabela abaixo).

Ações permitidas (can)

Ação	O que permite
activate	Ativar um token com o produto.
reactivate	Reativar um token suspenso com o produto.
change_to_this_product	Trocar outro produto por este.
change_from_this_product	Trocar este produto por outro.
suspend	Suspender temporariamente um token com o produto, sem cancelamento definitivo.
deactivate	Cancelar definitivamente um token com o produto.

📘
Produtos podem variar por usuário
A lista de produtos depende do usuário autenticado, então usuários diferentes podem ver conjuntos diferentes. Já os dados de cada produto (ID, nome e código) são os mesmos para todos.

Exemplo de resposta:

{
  "content_supplier_products": [
    {
      "id": 25,
      "name": "Globoplay com Anúncios",
      "code": "globoplay_anuncio",
      "active": true,
      "can": [
        "activate",
        "reactivate",
        "change_to_this_product",
        "change_from_this_product",
        "suspend",
        "deactivate"
      ]
    },
    {
      "id": 34,
      "name": "Globoplay Premium",
      "code": "globoplay_premium",
      "active": true,
      "can": [
        "activate",
        "reactivate",
        "change_to_this_product",
        "change_from_this_product",
        "suspend",
        "deactivate"
      ]
    }
  ],
  "response": "success"
}

🚀
Use o ID como ele vem na lista
O id de cada produto é o que você informa nas ações de Provisionamento. Use-o exatamente como retornado.

Listar status de produto

GET /products/status

Retorna os status que um produto pode assumir na plataforma. Cada status indica em que ponto do ciclo de vida o produto está.

Campos do status

Campo	Tipo	Descrição
`id`	integer	Identificador.
`name`	string	Nome.

Exemplo de resposta:

{
    "status": [
        {
            "id": 1,
            "name": "active"
        },
        {
            "id": 3,
            "name": "canceled"
        },
        {
            "id": 4,
            "name": "suspend"
        },
        {
            "id": 6,
            "name": "limitReached"
        },
        {
            "id": 7,
            "name": "overdue"
        },
        {
            "id": 10,
            "name": "inProgress"
        },
        {
            "id": 11,
            "name": "error"
        },
        {
            "id": 12,
            "name": "reactivated"
        },
        {
            "id": 13,
            "name": "changed"
        },
        {
            "id": 14,
            "name": "waitingSuspension"
        },
        {
            "id": 15,
            "name": "waitingCancellation"
        },
        {
            "id": 21,
            "name": "canceledWithoutActivation"
        },
        {
            "id": 22,
            "name": "waitingSuspensionDueToOverdue"
        }
    ],
    "response": "success"
}

Classificação dos status

Os status se dividem em duas categorias:

Final: esses status indicam que a ação executada para o serviço foi concluída.

Status	Descrição
`active`	O serviço está habiliatdo.
`canceled`	O serviço foi cancelado permanentemente.
`suspend`	O serviço está temporariamente suspenso.
`overdue`	O serviço está temporariamente suspenso por falta de pagamento.

Intermediário: Esses status indicam que o serviço está em transição, aguardando a finalização de uma ação ou a confirmação de terceiros.

Status	Descrição
`limitReached`	Indica que não foi possível ativar o serviço porque o provedor atingiu o limite de tokens. É necessário entrar em contato com seu sucesso do cliente (CS) para solicitar o aumento do limite. Assim que o limite for ampliado, os tokens serão ativados automaticamente.
`inProgress`	A solicitação de ativação do serviço está em andamento.
`error`	Ocorreu uma falha durante o processamento da solicitação ou da ação.
`reactivated`	O serviço está em um processo de reativação.
`changed`	O serviço está sofrendo uma alteração/troca de produto.
`waitingSuspension`	O serviço está aguardando a confirmação de suspensão.
`waitingCancellation`	O serviço está aguardando a confirmação do cancelamento.
`canceledWithoutActivation`	O serviço foi cancelado antes de ser habilitado. Ocorre exclusivame quando o serviço no status `limitReached` é cancelado.
`waitingSuspensionDueToOverdue`	O serviço está aguardando a confirmação de suspensão.

⚠️
A sequência de status varia
Os status usados e a ordem em que aparecem dependem da operação realizada e, portanto, do endpoint utilizado.