Processo de Provisionamento no TOTVS Consignado via TOTVS Adesão
O processo de provisionamento de clientes no TOTVS Consignado é realizado através do módulo TOTVS Adesão. A equipe responsável pelo TOTVS Adesão utiliza os endpoints do Consignado para enviar as informações do cliente, incluindo os CNPJs e os parceiros conveniados que devem ser habilitados ou desabilitados.
Com as novas funcionalidades, será possível realizar as seguintes operações:
Habilitar um Novo Cliente:
Habilitar um Novo CNPJ para um Cliente Existente:
Habilitar um Novo Parceiro para um Cliente Existente:
Desintegrar um CNPJ de um Cliente Existente:
Desintegrar um Parceiro de um Cliente Existente:
Desintegrar um Cliente Totalmente:
A seguir um detalhamento dos endpoints e a função de cada um deles:
ENDPOINT:
Abaixo os campos a serem informados na chamada ao endpoint:
Exemplo de Curl:
curl --location 'https://localhost:5001/api/provisioning/v1/environment/generate-environment' \ --header 'accept: text/plain' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \ --header 'Content-Type: application/json-patch+json' \ --data-raw '{ "fluigTenantId": "4b151eb39a9f40a6a44d222241af7e12", "enterpriseName": "Tenant Teste", "enterpriseCNPJ": "57240135000141", "adminEmail": "[email protected]", "adesaoId": "13f5764d-1e4b-4f45-8c93-e0bb10041273", "totvsCode": "TDEV01", "erpSource": 1, "genericPartnerCompanies": [ { "partnerCode": "0039", "partnerCompanies": [ { "cnpj": "17899772000100", "socialReason": "Parceiro Ja existente I", "streetAddress": "RUA", "number": "123", "complement": "CASA", "zipCode": "313178524", "neighborhood": "AL", "city": "BH", "state": "MG" } ] }, { "partnerCode": "0001", "partnerCompanies": [ { "cnpj": "71278900000143", "socialReason": "Parceiro Ja existente II" } ] } ] } '
Regras de Provisionamento e Habilitação no TOTVS Consignado
Durante o processo de provisionamento no TOTVS Consignado, algumas regras e condições específicas devem ser seguidas:
Dados de Endereço Obrigatórios para Parceiros Techfin (0039):
Criação de Ambiente no RAC/Carol se Inexistente:
Se o cliente já possui um ambiente previamente provisionado, os parceiros e CNPJs informados na chamada serão avaliados e habilitados dentro do módulo Consignado, conforme as permissões e requisitos.
Abaixo os campos a serem informados na chamada ao endpoint:,
Exemplo de Curl:
curl --location 'https://localhost:5001/api/provisioning/v1/environment/generate-environment' \ --header 'accept: text/plain' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "fluigTenantId": "4b151eb39a9f40a6a44d222241af7e18", "genericPartnerCompanies": [ { "partnerCode": "0001", "partnerCompanies": [ { "cnpj": "17899772000100", "socialReason": "Parceiro Ja existente I" } ] }, { "partnerCode": "0039", "partnerCompanies": [ { "cnpj": "71278900000143", "socialReason": "Parceiro Ja existente II", "streetAddress": "RUA", "number": "123", "complement": "CASA", "zipCode": "313178524", "neighborhood": "AL", "city": "BH", "state": "MG" } ] } ] } '
Regras de Inclusão de um Provisionamento já existente no TOTVS Consignado
Durante o processo de inclusão de um provisionamento já existente no TOTVS Consignado, algumas regras e condições específicas devem ser observadas:
Dados de Endereço Obrigatórios para Parceiros Techfin (0039):
Inclusão de Múltiplos Parceiros para o Mesmo CNPJ:
'
Endpoint:
Método | URL |
---|---|
DELETE | https://api-consignado.totvs.app/api/provisioning/v1/environment/provisioning-Disable |
A seguir, estão os campos que devem ser informados na chamada ao endpoint:
Exemplo de Curl:
curl --location --request DELETE 'https://localhost:5001/api/provisioning/v1/environment/provisioning-Disable' \ --header 'accept: text/plain' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjJiYjZmYzUyM2ZjNzQwZjI4NmMxOTZmY2ExMzUyNzE2IiwidHlwIjoiSldUIn0.eyJuYmYiOjE3MjcyNzMzMzcsImV4cCI6MTcyNzI3NDUzNywiaXNzIjoiaHR0cHM6Ly9hZG1pbi5yYWMuZGV2LnRvdHZzLmFwcC90b3R2cy5yYWMiLCJhdWQiOiJhdXRob3JpemF0aW9uX2FwaSIsImNsaWVudF9pZCI6ImNvbnNpZ25hZG9fcHJvdmlzaW9uaW5nXzY5ZjM1NjI0NmMxMDRmZDhiZjI3NDdmNGUzMTNlNDUwIiwiaHR0cDovL3d3dy50bmYuY29tL2lkZW50aXR5L2NsYWltcy9wcm9kdWN0SWQiOiIzMiIsImh0dHA6Ly93d3cudG5mLmNvbS9pZGVudGl0eS9jbGFpbXMvcHJvZHVjdE5hbWUiOiIrU2FsZG8iLCJpYXQiOjE3MjcyNzMzMzcsInNjb3BlIjpbImF1dGhvcml6YXRpb25fYXBpIl19.llYVako6Fm0AYMy-fI3ttV0ISJdBObr3MZNvWohxSI6y1u1B-BS7Q_KHgknkaP0UUhkKBMvrrNdxJMRj_tDEKtWENu61eMFVDJfBAnZEMRpSoN_NNJhD3XJYou_7VVF2opvMQGxjqNOY2fyE6pv3ODH8CdqPmCmhi1wJh_omX662RaM-6NLRMuO6wLSSQnckQbQTnH1FedcLACth5qBdHTNYV7wi23Iz4_NlRIFKIMX5JHgd2HrCeNflJge_rPNYcY5PuDxmsnFR7cSmZfezCWc8wo8mExmbLzyXo2xYRHUoCkiGCuI2L4NQvpEDB0-mMhA-8NcDhf9Y4bRDIxPlCw' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "FluigTenantId": "2cc016582f849158b84-90d07697d1e6", "PartnerCompaniesDisable": [ { "PartnerCode": "0001", "CnpjDisable": [ { "Cnpj": "10349609000124" }, { "Cnpj": "69996530000138" } ] }, { "PartnerCode": "0039" } ] } '
Regras para desabilitar um Parceiro ou Cnpj de um provisionamento existente :
Desabilitação de Todos os CNPJs de um Parceiro:
cnpjDisable
não é obrigatório.Erro 400 - fluigTenantId:
Erro 400 - Código do Parceiro (partnerCode):