Provisionamento

Use estes endpoints para gerenciar os serviços dos assinantes. Cada serviço é representado por um token, e você pode:

• ativar um novo serviço, gerando um novo token;
• suspender um serviço temporariamente, com possibilidade de reativá-lo depois;
• reativar um serviço suspenso;
• cancelar um serviço definitivamente, tornando o token inutilizável;
• trocar um serviço ativo por outro, quando aplicável.

Quais ações cada produto permite

O campo can de cada produto em GET /products indica quais operações estão disponíveis para ele. O id do produto é o valor que você informa nas requisições desta página.

Payload padrão

Todos os endpoints, exceto /provision/change, recebem o mesmo payload:

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

Campos do payload padrão

Como as operações funcionam

Todas as operações são assíncronas. Ao enviar a requisição, o serviço passa para um status intermediário. Quando o parceiro confirma o evento ou a ação é finalizada, o status muda para o status final.

Ativar, reativar ou trocar serviço

POST /provision/activate

Permite operar em lote, com um ou mais assinantes por requisição. O resultado depende da situação atual de cada assinante:

Ativação

Ao ativar um serviço, o assinante recebe um e-mail com as instruções para concluir a ativação. O serviço só fica efetivamente ativo, com uso completo, depois que o assinante conclui esse processo.

Limite de serviços ativos

Cada provedor tem um limite máximo de serviços ativos (tokens) simultâneos, definido previamente pela nossa equipe. Quando o limite é atingido, novas ativações não são processadas na hora. Elas entram em uma fila de pendências com o status limitReached.

Assim que o limite é ajustado, as ativações pendentes são processadas automaticamente, na ordem em que foram recebidas. Cada uma segue o fluxo normal: o e-mail de ativação é enviado ao assinante e, quando ele conclui o processo, o serviço fica disponível.

Reativação

Só é possível reativar serviços com status suspend. Serviços cancelados não são elegíveis.

Ao enviar a requisição, o status muda para reactivated, indicando que o processo começou.

Quando o evento de reativação é confirmado, o status muda para active e o assinante volta a usar o serviço.

Troca

Substitui um serviço existente por outro.

Ao enviar a requisição, o produto é atualizado para o novo serviço e o status muda para changed.

Quando o evento de troca é confirmado, o status muda para active e o novo serviço fica disponível.

Suspender serviço

POST /provision/suspend

Suspende o serviço de um ou mais assinantes.

Ao enviar a requisição, o status muda para waitingSuspension, indicando que o processo começou.

Quando o evento de suspensão é confirmado, o status muda para suspend.

A suspensão é temporária e reversível. Durante esse período, o serviço fica indisponível para o assinante, mas pode ser reativado depois, sem que ele precise refazer o processo completo de ativação.

Trocar serviço de um assinante

POST /provision/change

Troca o serviço ativo de um único assinante por outro. Segue o mesmo fluxo de provisionamento da troca em /provision/activate. A diferença é que este endpoint opera em um assinante por vez, enquanto o de ativação aceita lotes.

Use-o quando precisar trocar o serviço de forma individual e controlada.

Exemplo de payload:

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

Campos da troca

Cancelar serviço

POST /provision/deactivate

Cancela o serviço de um ou mais assinantes.

Ao enviar a requisição, o status muda para waitingCancellation, indicando que o processo começou.

Quando o evento de cancelamento é confirmado, o status muda para canceled.