API REST Java - Plataforma de Gestão de Consentimento e Ciência de Uso dos Dados (PGCC)
Visão Geral
Bem-vindo à documentação da API REST Java da Plataforma de Gestão de Consentimento e Ciência de Uso dos Dados (PGCC). Esta API oferece um conjunto de funcionalidades para integração e automação de processos relacionados ao consentimento e conhecimento de dados.
Endpoints
Desenvolvimento
Homologação
Produção
Autenticação
A API utiliza autenticação baseada em tokens. Para acessar os endpoints protegidos, você deve incluir o token de autenticação no cabeçalho da requisição.
Authorization: Bearer {seu-token}
Obter Consentimento Endpoint: /consentimento
Método: GET
Descrição: Obtém a lista de consentimentos.
Parâmetros de Consulta:
status (opcional): Filtra os consentimentos pelo status. dataInicio (opcional): Filtra os consentimentos a partir de uma data de início. dataFim (opcional): Filtra os consentimentos até uma data de fim. Exemplo de Requisição:
Exemplo de Resposta:
Criar Consentimento Endpoint: /consentimento
Método: POST
Descrição: Cria um novo consentimento.
Corpo da Requisição:
Exemplo de Requisição:
Exemplo de Resposta:
Tratamento de Erros A API retorna códigos de status HTTP para indicar o sucesso ou falha das requisições. Aqui estão alguns dos códigos de status mais comuns:
200 OK: A requisição foi bem-sucedida. 201 Created: Um novo recurso foi criado com sucesso. 400 Bad Request: A requisição está malformada ou faltam parâmetros obrigatórios. 401 Unauthorized: Falha na autenticação. Verifique o token de acesso. 404 Not Found: O recurso solicitado não foi encontrado. 500 Internal Server Error: Ocorreu um erro no servidor. Contato Se você tiver dúvidas ou precisar de suporte, entre em contato conosco através do e-mail suporte@pgcc.com.
Esperamos que esta documentação ajude você a integrar e utilizar a API REST Java da PGCC de forma eficiente. Boas integrações!