Manual integração Renovação Corporativa automática
v1.0
Serviço para atualização das informações cadastrais de uma aplicação.
Contato
Em caso de dúvidas ou dificuldades na integração você pode entrar em contato conosco através do email:
suportecorp.certificadora@valid.com
URIs base do Valid PSC
Produção: https://certificado.vidaas.com.br
Homologação: https://hml-certificado.vidaas.com.br
Demonstração: https://demo-certificado.vidaas.com.br
Casos de uso
https://valid-sa.atlassian.net/browse/VIDAASPSC-2389
Manutenção da lista negativa (Liberar ou bloquear renovação futura: altera status de um médico para ser elegível à Renovação do certificado digital)Como plataforma Commercial Service precisamos que o parceiro nos avise sempre que a sua lista negativa for alterada.
Os tipos de eventos são:
Entrada na lista negativa,
Ticket
Sponsor: Adicionar Informações sobre o nome do parceiro (CRMs com pendência)
Saída da lista negativa
2792 Criar endpoint para Renovação instantânea de um usuário:
Dado que um usuário foi bloqueado em seu direito de uso por não ter autorização para renovar. Na sequência, se deslocou até a regional e resolveu o seu problema, o CFM pode solicitar uma renovação naquele instante.
2793 Consultar informações de renovações (Dados de renovações com filtro de data: Retorna dados relativos à quantidade de renovações realizadas em um período.)
O parceiro deverá passar a data inicial, data final, RD
Retornamos
A quantidade de certificados que atingiram o limite do direito de uso naquele intervalo
A quantidade de certificados que foram renovados
CPF
Nome completo
Data de renovação
Nova data de direito de uso
O valor total cobrado no intervalo = Preço unitário x QTD de renovações
2794 Consultar status de um certificado (Dados de um usuário pelo identificador: Retorna status do certificado de um médico.)
O parceiro envia ticket ou CPF
Retornamos o status do seu contrato naquele momento: ativo, bloqueado, cancelado, revogado
1.Swagger de API de integração com parceiros
1.1 - Processamento Assíncrono dos dados
A api receberá as requisição retornando status 200 para sucesso no recebimento, 400 para erros de validações na entrada de dados (tipos de valores, dados obrigatórios faltando, formato de payload diferente). O processamento será realizado de forma assíncrona por consumo de fila FIFO para cada usuário enviado.
Será limitada ao número máximo de 1000 usuários enviados para processamento por requisição.
1.2 - Tempos estimados de processamento
Com tempo estimado de x ms de processamento por usuário. Levando-se em consideração a fila de espera para que os dados sejam processado em um tempo estimado x * (n + 1) ms, onde x tempo de processamento e n o número de dados na fila para serem processados.
Trabalhando com escalabilidade em horários de maior volume e paralelismo visando sempre reduzir a fila de processamento e otimizar o processo.
1.3 - Data de envio / data de renovação
Com processamento assíncrono e podendo haver alta demandas, é recomendado que o envio de dados de usuários para manutenção da lista negativa seja feita com pelo menos 1 dia de antecedência a data de expiração/renovação do direito de uso do certificado do usuário.
Dados como data/hora de recebimento e processamento são salvos como histórico para processos de auditoria.
1.4 - Acesso a documentação a api
O arquivo em anexo openapi-docs.json contém a documentação swagger, sendo necessário um sistema como SwaggerEditor para visualização da documentação. Com a disponibilização da api swagger-ui estará disponível nos ambientes.
1.4 - Autenticação na api
Antes de poder chamar alguns endpoints é necessário solicitar um access_token conforme detalhado a seguir.
Path : <URI-base>/v0/oauth/client_token
Utilizado processo OAuth2 com fluxo ClientCredentials
Verbo HTTP: POST
Cabeçalho
Content-type: application/x-www-form-urlencoded ;
Corpo da requisição no formato "application/x-www-form-urlencoded"
grant_type: obrigatório, valor "client_credentials"
client_id: obrigatório, deve conter a identificação da aplicação
client_secret: obrigatório, deve conter a senha da aplicação
Exemplo de requisição e resposta com o access_token e sua validade (expires_in, em segundos)
Requisição e resposta
Valid Certificadora Ltda