Provisionamento

Os endpoints de provisionamento permitem realizar operações relacionadas ao gerenciamento de serviços (cada um representado por um token).

Esses endpoints foram projetados para oferecer uma gestão eficiente e flexível dos serviços, permitindo que os usuários:

• Ativem um novo serviço (gerando um novo token);

• Suspendam temporariamente um serviço, mantendo a possibilidade de reativação futura;

• Reativem um serviço previamente suspenso;

• Cancelem definitivamente um serviço, tornando o token inutilizável;

• Troquem um serviço ativo por outro, quando aplicável.

O payload desses endpoints, com exceção do endpoint /provision/change , devem estar no seguinte formato:

{
    "contentSupplierProduct": 25,
    "documents": ["89907446017"]
}

POST /provision/activateCopied!

Este endpoint permite ativar, reativar ou trocar o serviço de um ou mais assinantes, de acordo com a situação atual de cada um:

• Ativação: caso o assinante ainda não possua o serviço, ele será ativado.

• Reativação: se o serviço estiver suspenso, será reativado.

• Troca: se o serviço atual permitir substituição, ele será trocado conforme a nova solicitação.

AtivaçãoCopied!

Ao ser ativado, o serviço entra inicialmente no status “checkout”, e um e-mail de ativação é enviado ao assinante. Esse e-mail contém instruções que devem ser seguidas para concluir a ativação.

Somente após o assinante concluir esse processo, o serviço será efetivamente ativado e o status atualizado para “active”, permitindo o uso completo da serviço contratado.

Limite de Serviços Ativos por Provedor

Cada provedor possui um limite máximo de serviços ativos (tokens) que pode manter simultaneamente. Esse limite é configurado previamente e define quantos tokens ativos (“checkout“ ou “active“) o provedor pode. Quando esse limite é atingido, novas solicitações de ativação não são processadas imediatamente. Em vez disso, essas ativações entram em uma fila de pendência e recebem o status “limitReached”.

Como funciona:

• O limite de tokens ativos é definido internamente (com base na configuração que aplicamos para cada provedor).

• Ao atingir esse limite, nenhum novo serviço pode ser ativado até que haja um aumento desse limite.

• Para liberar novas ativações, o provedor deve entrar em contato com o seu customer success e solicitar um aumento no limite.

Reprocessamento automático

Assim que o limite for ajustado:

• As ativações pendentes com status “limitReached” serão processadas automaticamente, na ordem em que foram recebidas.

• Cada ativação seguirá então o fluxo normal: o serviço passará para o status “checkout” (com envio de e-mail ao assinante) e, após ele concluir o processo de ativação, será ativado com o status “active”.

ReativaçãoCopied!

A reativação só é permitida para serviços que estejam no status “suspend”. Ou seja, apenas serviços suspensos podem ser reativados — serviços cancelados ou nunca ativados não são elegíveis para esse processo.

Ao enviar uma requisição de reativação:

1. O status do serviço é alterado para “reactivated”, indicando que o processo foi iniciado com sucesso.

2. Após o recebimento e processamento da confirmação do evento de reativação, o status é atualizado para o status em que o token estava antes de ser suspenso, sinalizando que o serviço está novamente disponível para uso pelo assinante.

TrocaCopied!

A troca de serviço permite substituir um serviço existente por outro, quando aplicável.

Ao enviar uma requisição de troca:

1. O status é atualizado para “changed” e o produto alterado, indicando que o processo de troca foi iniciado.

2. Após o recebimento e processamento da confirmação do evento de troca, o status é atualizado para "active", sinalizando que o novo serviço está ativo e disponível para uso.

POST /provision/suspendCopied!

Este endpoint é utilizado para suspender o serviço de um ou mais assinantes.

Ao enviar a requisição de suspensão:

1. O status do serviço é alterado para “waitingSuspension”, indicando que o processo de suspensão foi iniciado.

2. Após o recebimento e processamento da confirmação do evento de suspensão, o status é atualizado para ”suspend”, sinalizando que o serviço foi efetivamente suspenso

A suspensão é uma medida temporária e reversível. O serviço é desativado por um período, impedindo o seu acesso por parte do assinante, mas pode ser facilmente reativado posteriormente. Essa opção é ideal para situações como a falta de pagamento, onde há a expectativa de que o assinante possa regularizar sua situação e retomar o uso do serviço.

Ao suspender, garantimos uma transição mais simples e menos intrusiva: o assinante poderá voltar a usar o serviço imediatamente após a regularização, sem a necessidade de passar novamente pelo processo completo de ativação.

POST /provision/changeCopied!

Este endpoint permite que os usuários troquem um serviço ativo por outro para um assinante específico.

Ele pode ser considerado uma alternativa ao endpoint de ativação (/provision/activate), pois ambos seguem o mesmo fluxo de provisionamento.

A principal diferença é que este endpoint é projetado para operar com um único assinante por vez, enquanto o de ativação permite ações em lote.

Esse endpoint é útil em cenários onde é necessário atualizar ou substituir um serviço individualmente, de forma controlada.

Payload:

{
    "product_id": 34,
    "previous_product_id": 25,
    "document": "89907446017"
}

POST /provision/deactivateCopied!

Este endpoint é utilizado para cancelar o serviço de um ou mais assinantes.

Ao enviar a requisição de cancelamento:

1. O status do serviço é alterado para “waitingCancellation”, indicando que o processo foi iniciado.

2. Após o recebimento e processamento da confirmação do evento de cancelamento, o status é atualizado para “canceled”, sinalizando que o token com o serviço foi cancelado.