Pular para conteúdo

Roteiro de Demonstração - APIs Credencia

Este documento apresenta o roteiro de demonstração das APIs Credencia para Gerenciadoras de Consentimento e Ciência (GCC), focado em credenciamento e gestão de vínculos com usuários.


📋 Objetivo da Demonstração

Comprovar a capacidade técnica da GCC de:

  • Autenticar-se com certificado digital e-CNPJ ou de equipamento
  • Vincular usuários à GCC através da API Credencia
  • Gerenciar vínculos (consultar, atualizar, desativar)
  • Manter conformidade com processos de credenciamento

⚙️ Pré-requisitos

Antes da demonstração, a GCC deve:

✅ Possuir certificado e-CNPJ ou de equipamento da empresa válido (produção ou homologação)
✅ Ter solicitação de credenciamento autorizada e habilitada no ambiente de homologação do Credencia
✅ Ter ambiente de teste configurado com acesso à API Credencia
✅ Ter contrato de teste em formato PDF preparado para upload

🔐 Configuração Inicial


🎯 Etapas da Demonstração

Etapa 1: Vinculação de Usuário

Objetivo: Demonstrar a capacidade de vincular usuários à GCC através da API Credencia.

📌 Ações:

  1. Acessar a API Credencia - Módulo GCC
  2. Realizar vinculação de um usuário de teste usando:

    POST /api/v1/gccs/vinculos-gcc
    

  3. Informar os dados necessários:

{
  "numeroContrato": 1024,
  "dataInicioContrato": "01-11-2025",
  "dataVencimentoContrato": "01-11-2030",
  "dataAssinaturaContrato": "30-10-2025",
  "identificacaoDocumentoContrato": "CONTRATO-2025-001",
  "cnpjUsuario": "33683111000107",
  "codigoServicoNatureza": "2222"
}
  1. Anexar o arquivo do contrato (obrigatório):
    • Formato: .pdf
    • Campo multipart: file (arquivo) + data (JSON)

✅ Critérios de Sucesso:

  • Vinculação registrada com sucesso (HTTP 201 Created)
  • Retorno contendo ID do vínculo criado. Anote o idVinculo para consultas posteriores.
  • Contrato armazenado corretamente no sistema
  • Usuário visível na consulta de vínculos
  • ⚠️ O campo deAcordo estará com valor 0 (PENDENTE), aguardando confirmação do usuário.

📋 Confirmar Vínculo pelo Usuário (Obrigatório)

⚠️ IMPORTANTE: Após a criação do vínculo pela GCC, é obrigatório que o usuário confirme o vínculo através do Credencia. Sem esta confirmação, o vínculo permanecerá PENDENTE e não permitirá operações na PGCC.

  1. Instruir o usuário a acessar o Credencia e confirmar o vínculo, conforme Passo 7 do Passo a Passo de Credenciamento
  2. Verificar confirmação através de consulta ao vínculo:
    GET /api/v1/gccs/vinculos-gcc/{idVinculo}
    

Interpretar os Campos de Status

Campo Valor Significado
deAcordo 0 PENDENTE - Aguardando confirmação do usuário
deAcordo 1 CONFIRMADO - Usuário confirmou o vínculo
deAcordo 2 RECUSADO - Usuário recusou o vínculo
situacao 0 PENDENTE - Vínculo aguardando habilitação da Senatran
situacao 1 HABILITADO - Senatran habilitou o vínculo
situacao 2 DESABILITADO - Senatran desabilitou o vínculo
ativo true GCC ativou o vínculo
ativo false GCC desativou o vínculo

⏱️ Tempo Estimado: 20 minutos


Etapa 2: Consultas de Solicitações e Prospecção de Usuários

Objetivo: Demonstrar capacidade de prospectar e consultar usuários potenciais para vinculação.


📌 Cenário 2.1: Consultar Usuários sem Vínculo Ativo

Listar usuários autorizados que ainda não possuem vínculo ativo com a GCC:

GET /api/v1/gccs/solicitacoes-usuarios-sem-vinculo-ativo?codigoServicoNatureza=2222&offset=0&limit=20

Parâmetros:
- codigoServicoNatureza: Código do serviço (ex: 2222)
- offset: Número da página (padrão: 0)
- limit: Quantidade de registros por página (padrão: 0)

Resposta esperada:

{
  "solicitacoes": [
    {
      "nomeUsuario": "Exemplo Sistemas Tech Ltda.",
      "nomeFantasiaUsuario": "ExemploTech",
      "numeroInscricaoUsuario": "12345678000195",
      "numeroSolicitacao": "45/2025",
      "codigoServicoNatureza": "2222",
      "idSituacao": 0,
      "descricaoSituacao": "Autorizada",
      "idTipoNatureza": 0,
      "descricaoNatureza": "WS-SENATRAN CONSULTA ONLINE",
      "liberadoProducao": true,
      "dataPublicacaoDocumentoAutorizador": "2025-09-23T18:20:31Z",
      "contatos": [
        {
          "nome": "Nome ou Descrição do Contato",
          "email": "exemplo@email.com.br",
          "telefones": [
            "61999999999",
            "61988888888"
          ]
        }
      ]
    }
  ],
  "total": 0
}

Utilidade: Permite à GCC identificar potenciais clientes que já possuem autorização da SENATRAN, mas ainda não estabeleceram vínculo contratual com uma GCC.


📌 Cenário 2.2: Consultar Situação de Solicitações de um Usuário

Consultar detalhes das solicitações de um usuário específico por CNPJ:

GET /api/v1/gccs/solicitacoes-usuario/33683111000107?codigoServicoNatureza=2222&offset=0&limit=20

Resposta esperada:

{
  "solicitacoes": [
    {
      "nomeUsuario": "Exemplo Sistemas Tech Ltda.",
      "nomeFantasiaUsuario": "ExemploTech",
      "numeroInscricaoUsuario": "12345678000195",
      "numeroSolicitacao": "45/2025",
      "idVinculoGcc": 0,
      "codigoServicoNatureza": "2222",
      "idSituacao": 0,
      "descricaoSituacao": "Autorizada",
      "idTipoNatureza": 0,
      "descricaoNatureza": "WS-SENATRAN CONSULTA ONLINE",
      "liberadoProducao": true,
      "contratoVigente": true,
      "acessoBloqueado": true,
      "documentoAutorizadorVigente": true,
      "dataPublicacaoDocumentoAutorizador": "2025-09-23T18:20:31Z",
      "dataVencimentoDocumentoAutorizador": "2025-09-23T18:20:31Z",
      "contatos": [
        {
          "nome": "Nome ou Descrição do Contato",
          "email": "exemplo@email.com.br",
          "telefones": [
            "61999999999",
            "61988888888"
          ]
        }
      ]
    }
  ],
  "total": 0
}

Utilidade: Permite à GCC apoiar usuários consultando o status de suas solicitações, mesmo antes de estabelecer vínculo.


✅ Critérios de Sucesso da Etapa 2:

  • Listagem de usuários sem vínculo funcionando (HTTP 200 OK)
  • Consulta de solicitações por CNPJ retornando dados corretos
  • Dados de contato disponíveis para prospecção
  • Informações de situação e liberação acessíveis

⏱️ Tempo Estimado: 15 minutos


Etapa 3: Gestão Completa de Vínculos

Objetivo: Demonstrar todas as operações disponíveis para gestão de vínculos existentes.


📌 Cenário 3.1: Consultar Todos os Vínculos da GCC

Listar todos os vínculos da GCC (ativos e inativos):

GET /api/v1/gccs/vinculos-gcc?offset=0&limit=20

Parâmetros opcionais:
- numeroInscricao: Filtrar por CNPJ do usuário
- offset: Número da página (padrão: 0)
- limit: Quantidade de registros por página (padrão: 0)

Resposta esperada:

{
  "vinculosGcc": [
    {
      "id": 0,
      "numeroInscricaoGcc": "12345678000195",
      "nomeGcc": "Exemplo Sistemas Tech Ltda.",
      "numeroInscricaoUsuario": "12345678000195",
      "nomeUsuario": "Exemplo Sistemas Tech Ltda.",
      "natureza": "WS-SENATRAN CONSULTA ONLINE",
      "ativo": true,
      "situacao": "{ 'codigo': 0, 'descricao': 'string' }",
      "deAcordo": "{ 'codigo': 0, 'descricao': 'string' }",
      "casosUso": [
        {
          "idTemplateCredencia": "752024-00001",
          "nome": "Validar Documentos do Condutor"
        }
      ],
      "dataInclusao": "2025-09-23T18:20:31Z",
      "dataReativacao": "2025-09-23T18:20:31Z",
      "dataDesativacao": "2025-09-23T18:20:31Z",
      "eventos": [
        {
          "id": 0,
          "dataInicio": "2025-09-23T18:20:31Z",
          "dataFim": "2025-09-23T18:20:31Z",
          "dataRegistroEvento": "2025-09-23T18:20:31Z",
          "numeroInscricao": "12345678000195",
          "tipoPessoa": 2,
          "nomePessoa": "Nome da Pessoa Física ou Jurídica",
          "motivo": "Texto da motivação do evento.",
          "descricaoEvento": "O item foi Incluido",
          "documentos": [
            {
              "id": 0,
              "nome": "nome.pdf",
              "urlArquivo": "https://url.com.br/exemplo",
              "descricaoDocumento": "Texto da descrição do documento",
              "descricaoTipoDocumento": "Contrato ABC",
              "identificacaoDocumento": "Contrato Assinado com Empresa ABC",
              "numeroDocumento": 56,
              "dataInicio": "2025-09-23T18:20:31Z",
              "dataVencimento": "2025-09-23T18:20:31Z",
              "dataAssinatura": "2025-09-23T18:20:31Z",
              "dataInclusao": "2025-09-23T18:20:31Z"
            }
          ]
        }
      ]
    }
  ],
  "total": 0
}


📌 Cenário 3.2: Consultar Vínculo Específico

Buscar detalhes de um vínculo por ID:

GET /api/v1/gccs/vinculos-gcc/{idVinculo}

Resposta esperada:

{
  "id": 0,
  "numeroInscricaoGcc": "12345678000195",
  "nomeGcc": "Exemplo Sistemas Tech Ltda.",
  "numeroInscricaoUsuario": "12345678000195",
  "nomeUsuario": "Exemplo Sistemas Tech Ltda.",
  "natureza": "WS-SENATRAN CONSULTA ONLINE",
  "ativo": true,
  "situacao": "{ 'codigo': 0, 'descricao': 'string' }",
  "deAcordo": "{ 'codigo': 0, 'descricao': 'string' }",
  "casosUso": [
    {
      "idTemplateCredencia": "752024-00001",
      "nome": "Validar Documentos do Condutor"
    }
  ],
  "dataInclusao": "2025-09-23T18:20:31Z",
  "dataReativacao": "2025-09-23T18:20:31Z",
  "dataDesativacao": "2025-09-23T18:20:31Z",
  "eventos": [
    {
      "id": 0,
      "dataInicio": "2025-09-23T18:20:31Z",
      "dataFim": "2025-09-23T18:20:31Z",
      "dataRegistroEvento": "2025-09-23T18:20:31Z",
      "numeroInscricao": "12345678000195",
      "tipoPessoa": 2,
      "nomePessoa": "Nome da Pessoa Física ou Jurídica",
      "motivo": "Texto da motivação do evento.",
      "descricaoEvento": "O item foi Incluido",
      "documentos": [
        {
          "id": 0,
          "nome": "nome.pdf",
          "urlArquivo": "https://url.com.br/exemplo",
          "descricaoDocumento": "Texto da descrição do documento",
          "descricaoTipoDocumento": "Contrato ABC",
          "identificacaoDocumento": "Contrato Assinado com Empresa ABC",
          "numeroDocumento": 56,
          "dataInicio": "2025-09-23T18:20:31Z",
          "dataVencimento": "2025-09-23T18:20:31Z",
          "dataAssinatura": "2025-09-23T18:20:31Z",
          "dataInclusao": "2025-09-23T18:20:31Z"
        }
      ]
    }
  ]
}


📌 Cenário 3.3: Consultar Caso de Uso e Anuentes por Template

Consultar detalhes de um caso de uso específico do usuário e seus anuentes vinculados, caso seja de modalidade indireta:

GET /api/v1/gccs/vinculos-gcc/{idVinculo}/id-template/{idTemplateCredencia}

Resposta esperada:

{
  "nome": "Validar Documentos do Condutor",
  "numeroInscricaoUsuario": "12345678000195",
  "numeroSolicitacao": "45/2025",
  "descricaoSituacaoSolicitacao": "Autorizada",
  "acessoBloqueadoSolicitacao": true,
  "idTemplateCredencia": "752024-00001",
  "modalidadeAcesso": "{ 'codigo': 0, 'descricao': 'string' }",
  "plataformaConsentimento": "{ 'codigo': 0, 'descricao': 'string' }",
  "descricaoNatureza": "WS-SENATRAN CONSULTA ONLINE",
  "rotuloFinalidade": "Rótulo da finalidade que será exibido no consentimento.",
  "consequenciaRevogacao": "Texto da consequência da revogação para o titular dos dados",
  "grupos": [
    {
      "id": 0,
      "categoria": {
        "id": 0,
        "nome": "VEICULO",
        "descricao": "Informações de veículos da base RENAVAM"
      },
      "situacao": "{ 'codigo': 0, 'descricao': 'string' }",
      "parametrosEntrada": [
        {
          "id": 0,
          "nome": "CPF/CNPJ",
          "descricao": "CPF/CNPJ proprietario"
        }
      ],
      "parametrosSaida": [
        {
          "id": 0,
          "nome": "Proprietario Numero do Documento",
          "descricao": "Proprietario Numero do Documento",
          "lgpdPessoal": true,
          "lgpdSensivel": true,
          "restricao": "{ 'codigo': 0, 'descricao': 'string' }",
          "subcategoria": "Propriedade"
        }
      ]
    }
  ],
  "hipotesesTratamento": [
    {
      "id": 0,
      "tipoHipoteseTratamento": {
        "id": 0,
        "descricao": "I-Consentimento do titular",
        "exigeConsentimento": true
      }
    }
  ],
  "anuentes": [
    {
      "id": 0,
      "numeroInscricao": "12345678000195",
      "nome": "Exemplo Sistemas Tech Ltda.",
      "rotuloFinalidade": "Rótulo da finalidade que será exibido no consentimento.",
      "consequenciaRevogacao": "Texto da consequência da revogação para o titular dos dados",
      "urlPoliticaPrivacidade": "https://url.com.br/exemplo",
      "deAcordo": 0,
      "vinculoCasoUsoAtivo": true
    }
  ]
}

Utilidade: Permite à GCC visualizar os metadados do caso de uso, grupos de dados, parâmetros de entrada/saída e anuentes vinculados.


📌 Cenário 3.4: Atualizar Contrato do Vínculo

Atualizar o contrato de um vínculo existente (renovação, aditivo):

PATCH /api/v1/gccs/vinculos-gcc/{idVinculo}/atualizar-contrato
Content-Type: multipart/form-data

Body (multipart):
- data (application/json):
{
  "numeroContrato": 1024,
  "dataInicioContrato": "01-11-2025",
  "dataVencimentoContrato": "01-11-2032",
  "dataAssinaturaContrato": "15-11-2025",
  "identificacaoDocumentoContrato": "CONTRATO-2025-001-ADITIVO"
}
- file (application/pdf): arquivo.pdf

Cenários de atualização: - Renovação de contrato (nova data de vencimento) - Aditivo contratual (novos termos, novo PDF) - Prorrogação de prazo

⚠️ Importante: Este endpoint registra um evento de atualização no histórico do vínculo, mantendo o documento anterior para auditoria.


📌 Cenário 3.5: Desativar Vínculo

Demonstrar encerramento de vínculo:

DELETE /api/v1/gccs/vinculos-gcc/{idVinculo}
Content-Type: application/json

Body:
{
  "motivo": "Rescisão contratual por término de vigência"
}

Quando desativar:
- Término do contrato com usuário
- Rescisão antecipada
- Solicitação do usuário
- Descumprimento de termos contratuais

⚠️ Importante: A desativação não remove dados, apenas inativa o vínculo. O histórico completo é mantido para auditoria e conformidade.


📌 Cenário 3.6: Reativar Vínculo

Demonstrar reativação de vínculo previamente desativado:

PATCH /api/v1/gccs/vinculos-gcc/{idVinculo}/reativar
Content-Type: application/json

Body:
{
  "motivo": "Renovação de contrato após regularização"
}

Quando reativar:
- Renovação de contrato após término
- Resolução de pendências que causaram desativação
- Retomada de relacionamento comercial
- Após a reativação o vínculo ficará na situação PENDENTE de confirmação do usuário

⚠️ Importante: É necessário que exista pelo menos um contrato vigente para permitir a reativação.


✅ Critérios de Sucesso da Etapa 3:

  • Listagem de vínculos com filtros funcionando (HTTP 200 OK)
  • Consulta individual retornando dados completos com histórico de eventos
  • Consulta de caso de uso retornando metadados e anuentes
  • Atualização de contrato bem-sucedida (HTTP 200 OK)
  • Desativação registrada corretamente (HTTP 200 OK)
  • Reativação funcionando quando há contrato vigente (HTTP 200 OK)
  • Histórico de eventos mantido para auditoria

⏱️ Tempo Estimado: 35 minutos


📊 Diagrama do Fluxo Completo de Vinculação

sequenceDiagram
    participant GCC
    participant Credencia
    participant Usuario

    Note over GCC: Prospecção
    GCC->>Credencia: 1. GET /solicitacoes-usuarios-sem-vinculo-ativo
    Credencia-->>GCC: 2. Lista de usuários autorizados

    GCC->>Credencia: 3. GET /solicitacoes-usuario/{cnpj}
    Credencia-->>GCC: 4. Detalhes da solicitação do usuário

    Note over GCC,Usuario: Estabelecimento de Vínculo
    GCC->>Usuario: 5. Contato comercial
    Usuario->>GCC: 6. Assina contrato

    GCC->>Credencia: 7. POST /vinculos-gcc (JSON + PDF)
    Credencia-->>GCC: 8. 201 Created (ID do vínculo)

    Credencia->>Usuario: 9. Notifica sobre vínculo pendente
    Usuario->>Credencia: 10. Confirma vínculo (de acordo)
    Credencia-->>GCC: 11. Webhook: vínculo confirmado

    Note over GCC,Credencia: Gestão do Vínculo
    GCC->>Credencia: 12. GET /vinculos-gcc/{id}
    Credencia-->>GCC: 13. Detalhes completos + histórico

    GCC->>Credencia: 14. GET /vinculos-gcc/{id}/id-template/{template}
    Credencia-->>GCC: 15. Metadados do caso de uso + anuentes

    Note over GCC,Usuario: Ciclo de Vida do Contrato
    alt Renovação/Aditivo
        GCC->>Credencia: 16. PATCH /vinculos-gcc/{id}/atualizar-contrato
        Credencia-->>GCC: 17. 200 OK (evento registrado)
    end

    alt Rescisão
        GCC->>Credencia: 18. DELETE /vinculos-gcc/{id}
        Credencia-->>GCC: 19. 200 OK (vínculo desativado)
    end

    alt Reativação
        GCC->>Credencia: 20. PATCH /vinculos-gcc/{id}/reativar
        Credencia-->>GCC: 21. 200 OK (vínculo reativado)
    end

📊 Resumo das Operações da API Credencia

Operação Endpoint Método Descrição
Incluir vínculo /api/v1/gccs/vinculos-gcc POST Cria novo vínculo GCC-Usuário com upload de contrato
Listar vínculos /api/v1/gccs/vinculos-gcc GET Lista todos os vínculos da GCC com filtros
Consultar vínculo /api/v1/gccs/vinculos-gcc/{id} GET Obtém detalhes completos de um vínculo com histórico
Consultar caso de uso /api/v1/gccs/vinculos-gcc/{id}/id-template/{templateId} GET Obtém metadados, grupos de dados e anuentes
Atualizar contrato /api/v1/gccs/vinculos-gcc/{id}/atualizar-contrato PATCH Atualiza contrato com novo PDF (aditivo/renovação)
Desativar vínculo /api/v1/gccs/vinculos-gcc/{id} DELETE Inativa vínculo com registro de motivo
Reativar vínculo /api/v1/gccs/vinculos-gcc/{id}/reativar PATCH Reativa vínculo desativado
Consultar usuários sem vínculo /api/v1/gccs/solicitacoes-usuarios-sem-vinculo-ativo GET Lista usuários autorizados sem vínculo ativo
Consultar solicitações por usuário /api/v1/gccs/solicitacoes-usuario/{cnpj} GET Consulta situação de solicitações de um usuário

Total de operações: 9 endpoints


⏱️ Tempo Total Estimado

Etapa Tempo
Etapa 1: Vinculação de Usuário 20 min
Etapa 2: Consultas de Solicitações e Prospecção 15 min
Etapa 3: Gestão Completa de Vínculos 35 min
Total ~1h 10min

✅ Checklist de Validação - APIs Credencia

Antes da demonstração, verifique:

Infraestrutura e Certificados

  • [ ] Certificado e-CNPJ ou de equipamento válido e instalado
  • [ ] Certificado testado com sucesso nas APIs

Acesso à API Credencia

  • [ ] Acesso à API de homologação funcionando
  • [ ] Autenticação via certificado testada e funcionando
  • [ ] Certificado contendo CNPJ da GCC configurado corretamente
  • [ ] Timeouts e retry configurados

Operações de Vínculos

  • [ ] Capaz de criar vínculos com usuários
  • [ ] Upload de contrato em PDF funcionando
  • [ ] Consulta de todos os vínculos operacional (com filtros)
  • [ ] Consulta de vínculo específico testada (com histórico completo)
  • [ ] Consulta de caso de uso e anuentes funcionando
  • [ ] Atualização de contrato (PATCH) testada com novo PDF
  • [ ] Desativação de vínculos com motivo operacional
  • [ ] Reativação de vínculos testada

Operações de Prospecção

  • [ ] Consulta de usuários sem vínculo ativo funcionando
  • [ ] Consulta de solicitações por CNPJ do usuário operacional
  • [ ] Dados de contato retornando corretamente

Dados de Teste

  • [ ] CNPJ de usuário de teste válido (ex: 33683111000107)
  • [ ] Contrato de teste em PDF preparado
  • [ ] Dados contratuais de teste definidos
  • [ ] Massa de dados de teste completa

Documentação

  • [ ] Documentação da API Credencia estudada
  • [ ] Fluxo de credenciamento compreendido
  • [ ] Processo de confirmação pelo usuário conhecido

🔍 Observações Técnicas - Credencia

Sobre Autenticação

  • Todas as operações requerem certificado digital e-CNPJ ou de equipamento
  • O certificado deve conter o CNPJ da GCC autorizada
  • A GCC é identificada automaticamente através do CNPJ contido no certificado
  • O certificado deve estar habilitado no Credencia para o ambiente (homologação ou produção)
  • Validar certificado antes da demonstração

Sobre Vínculos

  • Vínculo requer contrato formal entre GCC e Usuário
  • Contrato deve ser anexado em formato PDF
  • Usuário deve confirmar o vínculo no sistema Credencia
  • Apenas vínculos ATIVO e confirmados permitem operações na PGCC
  • Histórico de vínculos mantido para conformidade e auditoria
  • Desativação não remove dados, apenas inativa o vínculo
  • Reativação só é possível se existir contrato vigente
  • Cada evento (criação, atualização, desativação, reativação) é registrado no histórico

Sobre Atualização de Contratos

  • Usar PATCH /atualizar-contrato para aditivos e renovações de contrato com os usuários
  • Novo documento PDF deve ser enviado via multipart/form-data
  • Atualização gera novo evento no histórico
  • Documento anterior é mantido para auditoria
  • Permite rastreabilidade completa do ciclo de vida contratual

Sobre Prospecção de Usuários

  • Endpoint /solicitacoes-usuarios-sem-vinculo-ativo identifica potenciais clientes
  • Lista usuários com solicitação autorizada mas sem vínculo ativo
  • Inclui dados de contato para abordagem comercial
  • Endpoint /solicitacoes-usuario/{cnpj} permite apoio ao cliente
  • GCC pode consultar status mesmo antes de estabelecer vínculo
  • Dados retornados são limitados se não houver vínculo ativo

Sobre Casos de Uso

  • Endpoint /vinculos-gcc/{id}/id-template/{templateId} retorna metadados completos
  • Inclui grupos de dados, parâmetros de entrada/saída e anuentes
  • Permite GCC entender quais dados podem ser consultados
  • Identifica se dados são pessoais ou sensíveis (LGPD)
  • Mostra modalidade de acesso (DIRETO/INDIRETO) e se utiliza a plataforma PGCC da Senatran ou própria do usuário para obter o consentimento do titular

Sobre Contratos

  • Formato aceito: PDF
  • Tamanho máximo: verificar documentação (limite máximo de 3 MB)
  • Upload via multipart/form-data
  • Contrato é armazenado e vinculado ao registro
  • Possível substituir contrato via atualização

Sobre Segurança

  • Implementar rate limiting no lado da GCC
  • Validar todas as entradas antes de enviar
  • Usar HTTPS em todas as comunicações
  • Implementar timeout adequado (ex: 60 segundos)
  • Tratar erros de forma segura

Sobre Logs e Auditoria

  • Todas as operações devem ser logadas
  • Logs devem conter: data/hora, operador, operação, resultado
  • Manter logs por período legal mínimo (conforme LGPD)
  • Implementar monitoramento em tempo real

📚 Documentação de Referência

APIs Credencia

Guias e Fluxos

Próximos Passos