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 aos usuários:

• Ativar um novo serviço, gerando um novo token;
• Suspender temporariamente um serviço, mantendo a possibilidade de reativá-lo futuramente;
• Reativar um serviço previamente suspenso;
• Cancelar definitivamente um serviço, tornando seu token inutilizável;
• Trocar 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/activate

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: caso o serviço esteja suspenso, ele será reativado.
• Troca: caso o serviço atual permita substituição, ele será substituído pelo serviço solicitado.

Ativação

Ao ser ativado 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, permitindo o uso completo do 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 determina a quantidade máxima de tokens ativos permitida para o provedor.

Quando esse limite é atingido, novas solicitações de ativação não são processadas imediatamente. Em vez disso, as solicitações são colocadas em uma fila de pendências e recebem o status limitReached.

Como funciona:

• O limite de tokens ativos é definido internamente, com base na configuração estabelecida para cada provedor.
• Ao atingir esse limite, nenhum novo serviço poderá ser ativado até que a capacidade seja ampliada.
• Para liberar novas ativações, o provedor deve entrar em contato com seu Customer Success e solicitar o aumento do 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á o fluxo normal: o serviço será ativado e um e-mail de ativação será enviado ao assinante. Após a conclusão do processo de ativação pelo assinante, o serviço estará disponível para uso.

Reativação

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 não são elegíveis para esse processo.

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

• O status do serviço é alterado para reactivated, indicando que o processo de reativação foi iniciado com sucesso.
• Após o recebimento e processamento da confirmação do evento de reativação, o status é atualizado para active, indicando que o serviço foi reativado e está novamente disponível para uso pelo assinante.

Troca

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

Ao enviar uma requisição de troca:

• O produto é atualizado para o novo serviço solicitado, e o status é alterado para changed, indicando que o processo de troca foi iniciado.
• Após o recebimento e processamento da confirmação do evento de troca, o status é atualizado para active, indicando que o novo serviço foi ativado e está disponível para uso.

POST /provision/suspend

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

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

• O status do serviço é alterado para waitingSuspension, indicando que o processo de suspensão foi iniciado.
• Após o recebimento e processamento da confirmação do evento de suspensão, o status é atualizado para suspend, indicando que o serviço foi efetivamente suspenso.

A suspensão é uma medida temporária e reversível. Durante esse período, o serviço permanece desativado e indisponível para o assinante, mas pode ser reativado posteriormente.

Essa opção é indicada para situações como inadimplência, nas quais existe a expectativa de que o assinante regularize sua situação e retome o uso do serviço.

Ao suspender um serviço, garantimos uma transição mais simples e menos intrusiva. Após a regularização, o assinante poderá voltar a utilizar o serviço sem precisar passar novamente pelo processo completo de ativação.

POST /provision/change

Este endpoint permite trocar o serviço ativo de um assinante por outro serviço.

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 está na forma de operação: este endpoint é destinado à troca de serviço de um único assinante por vez, enquanto o endpoint de ativação permite realizar operações em lote.

Esse endpoint é especialmente útil em cenários que exigem a atualização ou substituição individual de um serviço, de forma controlada.

Payload:

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

POST /provision/deactivate

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

Ao enviar uma requisição de cancelamento:

• O status do serviço é alterado para waitingCancellation, indicando que o processo de cancelamento foi iniciado.
• Após o recebimento e processamento da confirmação do evento de cancelamento, o status é atualizado para canceled, indicando que o serviço foi efetivamente cancelado e que o token associado não poderá mais ser utilizado.