Produtos

GET /productsCopied!

Este endpoint retorna todos os produtos (serviços) disponíveis para serem comercializados pelo provedor para seus assinantes.

Por favor, observe que os produtos fornecidos por esta API podem variar dependendo do usuário autenticado. No entanto, os dados individuais de cada produto permanecem os mesmos, independentemente do usuário. Isso significa que, embora diferentes usuários possam visualizar conjuntos de produtos diferentes, os detalhes específicos de cada produto, como ID, nome e código, serão os mesmos para todos os usuários.

Exemplo:

{
    "content_supplier_products": [
        {
	    "id": 1,
	    "name": "Globoplay",
	    "code": "globoplay"
	},
	{
	    "id": 2,
	    "name": "Globoplay + Canais",
	    "code": "globoplay_canais"
        }
    ]
    "message": "success"
}

Se não existir nenhum produto:

{
    "content_supplier_products": [],
    "message": "success"
}

O ID de cada produto na lista pode ser usado para executar as ações de provisionamento nos endpoints correspondentes. Apenas certifique-se de usar o ID do produto exatamente como fornecido na lista.

GET /products/statusCopied!

Este endpoint retorna os possíveis status que um produto pode ter em nossa plataforma. Cada status fornece informações sobre o estado atual do produto.

Exemplo de lista de status:

{
    "status": [
        {
            "id": 1,
            "name": "active"
        },
        {
            "id": 2,
            "name": "scheduleCancel"
        },
        {
            "id": 3,
            "name": "canceled"
        },
        {
            "id": 4,
            "name": "suspend"
        },
        {
            "id": 5,
            "name": "checkout"
        },
        {
            "id": 6,
            "name": "limitReached"
        },
        {
            "id": 7,
            "name": "overdue"
        },
        {
            "id": 8,
            "name": "scheduledSuspension"
        },
        {
            "id": 9,
            "name": "revert"
        },
        {
            "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": 16,
            "name": "requested"
        },
        {
            "id": 17,
            "name": "canceledRequest"
        },
        {
            "id": 18,
            "name": "suspendedRequest"
        },
        {
            "id": 19,
            "name": "reactivatedRequest"
        },
        {
            "id": 20,
            "name": "changedRequest"
        },
        {
            "id": 21,
            "name": "canceledWithoutActivation"
        },
        {
            "id": 22,
            "name": "waitingSuspensionDueToOverdue"
        }
    ],
    "response": "success"
}

Os status são divididos em duas categorias:

intermediários: scheduleCancel, scheduledSuspension, limitReached, overdue, revert, inProgress, error, reactivated, changed, waitingSuspension, waitingCancellation, canceledRequest, suspendedRequest, reactivatedRequest, changedRequest.
finais de uma determinada ação/situação: active, canceled, suspend, checkout, requested.

Os status intermediários indicam estados transitórios do produto que exigem a ação/confirmação de terceiros para avançar para o status final da ação referente.

Por exemplo: um assinante tem o produto Globoplay ativo, então este está no status “active“. Ao ser realizada a ação de suspensão, nosso sistema irá alterar o status do produto para “waitingSuspension” e aguardará a suspensão definitiva do produto no sistema do nosso parceiro Globo. Quando ocorrer a suspensão, iremos alterar o status do produto desse assinante para o status final da ação suspensão: “suspension“.

A determinação de quais status serão usados e a ordem em que esses status serão aplicados dependem da ação executada (endpoint utilizado).