Documentação

Documentação da API

Consulte os grupos e endpoints utilizados pela Brapci.

Grupo da API

Buscar na documentação

56 endpoints encontrados.

Sobre

API de conteúdo institucional utilizada pelas páginas /about/:page. A rota da API é /api/page/{page}, consultando os registros da tabela about.

GET Consultar página institucional (about)

Endpoint da API: https://cip.brapci.inf.br/api/page/{page}
Endpoint relativo: /api/page/{page}
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY ou sessão de login.
Método no serviço: BrapciApiService.get(`page/${page}`)

Variáveis da API

Parâmetros de /api/page/{page}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`page`	`path`	`string`	Sim	Identificador da página. Valores usados pelo portal: brapci (Sobre a Brapci), benancib (Sobre o Benancib), brapcilivros (Brapci Livros), how_index (Como ser indexado na Brapci) e team (Equipe).	`brapci`

Exemplo de requisição

curl "https://cip.brapci.inf.br/api/page/brapci"

curl "https://cip.brapci.inf.br/api/page/benancib"

curl "https://cip.brapci.inf.br/api/page/brapcilivros"

curl "https://cip.brapci.inf.br/api/page/how_index"

curl "https://cip.brapci.inf.br/api/page/team"

Resultado da API

Retorna diretamente um array de blocos de conteúdo, ordenados por a_order crescente. O idioma está fixado em pt no backend; não há parâmetro de idioma. Cada row pode conter HTML ou texto simples. Sem registros para a página, retorna []. O exemplo abaixo é ilustrativo.

[
  {
    "row": "<ul><li><a href=\"#apresentacao\">Apresentação</a></li></ul>",
    "lang": "pt",
    "ordem": 0
  },
  {
    "row": "<section id=\"apresentacao\"><h2>Apresentação</h2><p>Sobre a Brapci.</p></section>",
    "lang": "pt",
    "ordem": 1
  }
]

Variáveis de retorno

Campos retornados por /api/page/{page}
Nome	Tipo	Descrição
`[]`	`array<object>`	Blocos da página na ordem de apresentação; array vazio quando não há conteúdo.
`[].row`	`string`	Conteúdo do bloco em HTML ou texto simples.
`[].lang`	`string`	Idioma do bloco. Atualmente pt.
`[].ordem`	`integer`	Valor de a_order. Blocos com ordem 0 compõem a navegação da página; os demais compõem o conteúdo.

Autenticação

Endpoints utilizados pelo AuthService para sessão, cadastro, login, OAuth, recuperação de senha e contato.

GET Consultar sessão

Endpoint da API: /auth/me
Endpoint relativo: /auth/me
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Cookie de sessão enviado com withCredentials.
Método no serviço: checkSession()

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Informa se existe uma sessão autenticada e retorna o usuário associado.

{
  "authenticated": true,
  "user": {
    "id": 1,
    "username": "usuario@exemplo.br",
    "name": "Nome do Usuário",
    "role": "user"
  }
}

Variáveis de retorno

Campos retornados por /auth/me
Nome	Tipo	Descrição
`authenticated`	`boolean`	Indica se a sessão está autenticada.
`user`	`object\|null`	Usuário autenticado ou null quando não há sessão.
`user.id`	`number`	Identificador do usuário.
`user.username`	`string`	Nome de usuário ou e-mail de acesso.
`user.name`	`string`	Nome de exibição do usuário.
`user.role`	`admin\|user`	Papel de autorização do usuário.
`user.token`	`string\|undefined`	Token opcional retornado por fluxos legados.
`user.themePreference`	`light\|dark\|undefined`	Preferência visual opcional armazenada no cliente.

POST Cadastrar usuário

Endpoint da API: /auth/register
Endpoint relativo: /auth/register
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer sessão prévia; cookies são enviados por se tratar de uma rota /auth.
Método no serviço: register(payload)

Variáveis da API

Parâmetros de /auth/register
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`name`	`body`	`string`	Sim	Nome completo do usuário.	`Nome do Usuário`
`username`	`body`	`string`	Sim	Nome de usuário para autenticação.	`usuario`
`email`	`body`	`string`	Sim	E-mail do usuário.	`usuario@exemplo.br`
`password`	`body`	`string`	Sim	Senha definida pelo usuário.	`********`

Resultado da API

Retorna o estado de autenticação e o usuário criado quando o cadastro é concluído.

{
  "authenticated": true,
  "user": {
    "id": 1,
    "username": "usuario",
    "name": "Nome do Usuário",
    "role": "user"
  }
}

Variáveis de retorno

Campos retornados por /auth/register
Nome	Tipo	Descrição
`authenticated`	`boolean`	Indica se o usuário ficou autenticado após o cadastro.
`user`	`object\|null`	Usuário criado ou null quando o cadastro não resulta em autenticação.

POST Encerrar sessão

Endpoint da API: /auth/logout
Endpoint relativo: /auth/logout
Content-Type: sem conteúdo
Precisa de APIKEY?: Não
Autenticação: Cookie da sessão enviado com withCredentials.
Método no serviço: logout()

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Encerra a sessão no servidor. O cliente também limpa a sessão local mesmo se a chamada falhar.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Solicitar recuperação de senha

Endpoint da API: https://cip.brapci.inf.br/auth/forgot-password
Endpoint relativo: /auth/forgot-password
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer autenticação.
Método no serviço: resendPassword(payload)

Variáveis da API

Parâmetros de /auth/forgot-password
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`email`	`query_string`	`string`	Sim	E-mail associado à conta.	`usuario@exemplo.br`

Resultado da API

Indica se a solicitação de recuperação foi aceita. Na ausência do campo success, o cliente considera a chamada bem-sucedida.

{
  "success": true
}

Variáveis de retorno

Campos retornados por /auth/forgot-password
Nome	Tipo	Descrição
`success`	`boolean\|undefined`	Resultado opcional da solicitação de recuperação.

POST Login legado

Endpoint da API: https://cip.brapci.inf.br/api/socials/signin
Endpoint relativo: /api/socials/signin
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer autenticação prévia.
Método no serviço: loginSubmitHttp(login, pass) / login(payload)

Variáveis da API

Parâmetros de /api/socials/signin
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`user`	`body`	`string`	Sim	Login ou e-mail do usuário.	`usuario@exemplo.br`
`pwd`	`body`	`string`	Sim	Senha do usuário.	`********`

Resultado da API

Retorno legado de autenticação. O AuthService aceita um objeto user ou uma resposta com status igual a 200 e normaliza os dados para User.

{
  "status": "200",
  "id": 1,
  "email": "usuario@exemplo.br",
  "displayName": "Nome do Usuário",
  "admin": false,
  "token": "token-opcional"
}

Variáveis de retorno

Campos retornados por /api/socials/signin
Nome	Tipo	Descrição
`status`	`string\|number`	Código de situação usado pelo formato legado.
`user`	`object\|undefined`	Usuário quando a API retorna o formato AuthResponse.
`id`	`number\|undefined`	Identificador no formato legado.
`email`	`string\|undefined`	E-mail usado para normalizar username.
`displayName`	`string\|undefined`	Nome de exibição no formato legado.
`givenName`	`string\|undefined`	Nome alternativo usado na normalização.
`persistent-id`	`string\|undefined`	Identificador alternativo usado na normalização.
`admin`	`boolean\|undefined`	Indica se o perfil deve ser normalizado como administrador.
`token`	`string\|undefined`	Token opcional de autenticação.

POST Callback OAuth legado

Endpoint da API: https://cip.brapci.inf.br/api/socials/callback2
Endpoint relativo: /api/socials/callback2
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Token OAuth enviado no corpo.
Método no serviço: callbackOauthHttp(token)

Variáveis da API

Parâmetros de /api/socials/callback2
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`token`	`body`	`string`	Sim	Token recebido do provedor OAuth.	`token-oauth`

Resultado da API

Resposta legada do callback OAuth, repassada pelo serviço sem transformação.

{}

Variáveis de retorno

Campos retornados por /api/socials/callback2
Nome	Tipo	Descrição
`response`	`object`	Objeto de resposta definido pela API legada.

POST Cadastro social legado

Endpoint da API: https://cip.brapci.inf.br/api/socials/signup
Endpoint relativo: /api/socials/signup
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer autenticação prévia.
Método no serviço: signUp(name, email, institution)

Variáveis da API

Parâmetros de /api/socials/signup
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`signup_name`	`body`	`string`	Sim	Nome da pessoa.	`Nome do Usuário`
`signup_email`	`body`	`string`	Sim	E-mail para cadastro.	`usuario@exemplo.br`
`signup_institution`	`body`	`string`	Sim	Instituição informada no cadastro.	`Universidade Exemplo`

Resultado da API

Resposta do cadastro social, repassada pelo serviço sem transformação.

{}

Variáveis de retorno

Campos retornados por /api/socials/signup
Nome	Tipo	Descrição
`response`	`object`	Objeto de resposta definido pela API legada.

POST Contato social legado

Endpoint da API: https://cip.brapci.inf.br/api/socials/contact
Endpoint relativo: /api/socials/contact
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer autenticação prévia.
Método no serviço: questionHttp(email, text)

Variáveis da API

Parâmetros de /api/socials/contact
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`email`	`body`	`string`	Sim	E-mail para contato.	`usuario@exemplo.br`
`text`	`body`	`string`	Sim	Texto da mensagem.	`Mensagem enviada pelo formulário de contato.`

Resultado da API

Resposta do envio de contato, repassada pelo serviço sem transformação.

{}

Variáveis de retorno

Campos retornados por /api/socials/contact
Nome	Tipo	Descrição
`response`	`object`	Objeto de resposta definido pela API legada.

POST Recuperação de senha legada

Endpoint da API: https://cip.brapci.inf.br/api/socials/forgot
Endpoint relativo: /api/socials/forgot
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Não requer autenticação prévia.
Método no serviço: forgotHttp(email)

Variáveis da API

Parâmetros de /api/socials/forgot
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`email`	`body`	`string`	Sim	E-mail associado à conta.	`usuario@exemplo.br`

Resultado da API

Resposta legada de recuperação de senha, repassada pelo serviço sem transformação.

{}

Variáveis de retorno

Campos retornados por /api/socials/forgot
Nome	Tipo	Descrição
`response`	`object`	Objeto de resposta definido pela API legada.

POST Login OAuth legado

Endpoint da API: https://cip.brapci.inf.br/api/socials/oauth2
Endpoint relativo: /api/socials/oauth2
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Token OAuth enviado no corpo.
Método no serviço: loginOauthHttp(token)

Variáveis da API

Parâmetros de /api/socials/oauth2
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`token`	`body`	`string`	Sim	Token emitido pelo provedor OAuth.	`token-oauth`

Resultado da API

Resposta legada de autenticação OAuth, repassada pelo serviço sem transformação.

{}

Variáveis de retorno

Campos retornados por /api/socials/oauth2
Nome	Tipo	Descrição
`response`	`object`	Objeto de resposta definido pela API legada.

Brapci

Documentação de /api/brapci organizada por subgrupos. Baseada no despachante Brapci3.1; ações delegadas indicam limites do contrato. Códigos status no JSON não equivalem necessariamente ao status HTTP.

Busca e recuperação

GET Buscar registros

Endpoint da API: https://cip.brapci.inf.br/api/brapci/search/{version}
Endpoint relativo: /api/brapci/search/{version}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/search/{version}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`version`	`path`	`string`	Sim	Parâmetro version; consulte as regras da operação.	`—`
`q`	`query_string`	`string`	Não	Termo de busca (ou IDs, na cesta).	`—`
`term`	`query_string`	`string`	Não	Alternativa a q para busca.	`—`

Resultado da API

Versões: a1, v3, v4 e v5. q tem precedência sobre term. Sem termo retorna []. O formato depende da versão. Exemplo ilustrativo baseado no código local; não representa dados de produção.

[]

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Consultar registro

Endpoint da API: https://cip.brapci.inf.br/api/brapci/get/{version}/{ID}
Endpoint relativo: /api/brapci/get/{version}/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/get/{version}/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`version`	`path`	`string`	Sim	Parâmetro version; consulte as regras da operação.	`—`
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

v1 e v2 usam os mesmos metadados. Retorna diretamente os metadados, Class, Views, Download, Likes e cited. Registra visualização; pode importar metadados ausentes. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "Class": "Article",
  "cited": {
    "abnt": "Referência ilustrativa",
    "apa": "Referência ilustrativa",
    "vancouver": "Referência ilustrativa"
  }
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Recuperar referências selecionadas

Endpoint da API: https://cip.brapci.inf.br/api/brapci/basket
Endpoint relativo: /api/brapci/basket
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/basket
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`row`	`query_string`	`string`	Não	IDs separados por vírgula.	`—`
`q`	`query_string`	`string`	Não	Termo de busca (ou IDs, na cesta).	`—`

Resultado da API

Concatena row e q e separa IDs por vírgula; prefira enviar somente row. Retorna row e ABNT. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "row": "227414,466086",
  "ABNT": []
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Exportar seleção

Endpoint da API: https://cip.brapci.inf.br/api/brapci/export/{format}
Endpoint relativo: /api/brapci/export/{format}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/export/{format}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`format`	`path`	`string`	Sim	Parâmetro format; consulte as regras da operação.	`—`

Resultado da API

Delega a ElasticSearch/Index::export. Formatos, parâmetros adicionais e conteúdo dependem do exportador; não há contrato JSON uniforme. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Obter texto completo

Endpoint da API: https://cip.brapci.inf.br/api/brapci/getText/{ID}
Endpoint relativo: /api/brapci/getText/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/getText/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

Delega a Base/Download::getText; formato definido pelo módulo de texto. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Fontes, fascículos e livros

GET Listar fontes

Endpoint da API: https://cip.brapci.inf.br/api/brapci/source/{type}
Endpoint relativo: /api/brapci/source/{type}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/source/{type}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`type`	`path`	`string`	Sim	Parâmetro type; consulte as regras da operação.	`—`

Resultado da API

Tipos: journal (aliases J e R), proceddings (grafia legada; alias E). Sem tipo específico lista todas. Retorna array com dados das fontes e capa. Exemplo ilustrativo baseado no código local; não representa dados de produção.

[]

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Consultar fascículo

Endpoint da API: https://cip.brapci.inf.br/api/brapci/issue/{ID}
Endpoint relativo: /api/brapci/issue/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/issue/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

Alias de issueV2. Retorna dados do fascículo e suas seções. Se inexistente, a implementação pode responder texto/HTML em vez de JSON. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Consultar fascículo detalhado

Endpoint da API: https://cip.brapci.inf.br/api/brapci/issueV2/{ID}
Endpoint relativo: /api/brapci/issueV2/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/issueV2/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

Retorna ID, source, nr, vol, legend, year e dados de trabalhos/autores. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "ID": 123,
  "source": {
    "name": "Periódico ilustrativo"
  },
  "year": 2026
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Linha do tempo de fontes

Endpoint da API: https://cip.brapci.inf.br/api/brapci/timeline/{type}
Endpoint relativo: /api/brapci/timeline/{type}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/timeline/{type}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`type`	`path`	`string`	Sim	Parâmetro type; consulte as regras da operação.	`—`

Resultado da API

Delega a Base/Sources::timeline; argumento repassado ao módulo. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Avaliações de periódicos

Endpoint da API: https://cip.brapci.inf.br/api/brapci/avaliations
Endpoint relativo: /api/brapci/avaliations
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Retorna data agrupado por fonte de avaliação e área. A mensagem ainda indica endpoint em construção. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200",
  "message": "Avaliations endpoint is under construction",
  "data": {}
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Vitrine de livros

Endpoint da API: https://cip.brapci.inf.br/api/brapci/book
Endpoint relativo: /api/brapci/book
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/book
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`row`	`query_string`	`string`	Não	IDs separados por vírgula.	`—`
`q`	`query_string`	`string`	Não	Termo de busca (ou IDs, na cesta).	`—`

Resultado da API

Sem subação chama Book::vitrine com row concatenado a q. Subações /book/{action}/{ID} são delegadas a Book::index. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Citações e palavras-chave

GET Buscar citações

Endpoint da API: https://cip.brapci.inf.br/api/brapci/cited-search
Endpoint relativo: /api/brapci/cited-search
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/cited-search
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`q`	`query_string`	`string`	Sim	Termo de busca (ou IDs, na cesta).	`—`

Resultado da API

q é obrigatório. Retorna status, status_message e works. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200",
  "status_message": "Busca realizada com sucesso",
  "works": []
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Associar citação

Endpoint da API: https://cip.brapci.inf.br/api/brapci/cited
Endpoint relativo: /api/brapci/cited
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Sim
Autenticação: Obrigatório enviar userAPIKEY com o token ativo do usuário. A validação ocorre antes da associação.

Variáveis da API

Parâmetros de /api/brapci/cited
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`body`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`
`ida`	`body`	`string`	Sim	Parâmetro ida; consulte as regras da operação.	`—`
`userAPIKEY`	`body`	`string`	Sim	APIKEY ativa retornada pelo login. Não enviar e-mail ou ID do usuário.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/brapci/cited' --data-urlencode 'idz=ID_CITACAO' --data-urlencode 'ida=ID_TRABALHO' --data-urlencode 'userAPIKEY=SEU_TOKEN'

Resultado da API

Associa idz e ida via joinCited somente após validar userAPIKEY. Chave ausente, desconhecida ou inativa retorna HTTP 401, sem modificar citações. A resposta de sucesso continua sendo a do módulo de citações. Exemplo abaixo: falha de autenticação.

{
  "status": "401",
  "message": "userAPIKEY ausente, invalida ou inativa"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Bloquear citações

Endpoint da API: https://cip.brapci.inf.br/api/brapci/citedLock
Endpoint relativo: /api/brapci/citedLock
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Sim
Autenticação: userAPIKEY ativa obrigatória; validada antes de qualquer alteração.

Variáveis da API

Parâmetros de /api/brapci/citedLock
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`body`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`
`userAPIKEY`	`body`	`string`	Sim	Token ativo do usuário retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/brapci/citedLock' --data-urlencode 'idz=ID_ALVO' --data-urlencode 'userAPIKEY=SEU_TOKEN'

Resultado da API

Operação de escrita: define ca_blocked=1 para ca_rdf igual a idz. Exemplo ilustrativo baseado no código local; não representa dados de produção. Chave ausente, inválida ou inativa retorna HTTP 401 com status "401" e message "userAPIKEY ausente, invalida ou inativa", sem modificar dados.

{
  "status": "200",
  "message": "Citações bloqueadas com sucesso"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Desbloquear citações

Endpoint da API: https://cip.brapci.inf.br/api/brapci/citedUnLock
Endpoint relativo: /api/brapci/citedUnLock
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Sim
Autenticação: userAPIKEY ativa obrigatória; validada antes de qualquer alteração.

Variáveis da API

Parâmetros de /api/brapci/citedUnLock
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`body`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`
`userAPIKEY`	`body`	`string`	Sim	Token ativo do usuário retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/brapci/citedUnLock' --data-urlencode 'idz=ID_ALVO' --data-urlencode 'userAPIKEY=SEU_TOKEN'

Resultado da API

Operação de escrita: define ca_blocked=0 para ca_rdf igual a idz. Exemplo ilustrativo baseado no código local; não representa dados de produção. Chave ausente, inválida ou inativa retorna HTTP 401 com status "401" e message "userAPIKEY ausente, invalida ou inativa", sem modificar dados.

{
  "status": "200",
  "message": "Citações desbloqueadas com sucesso"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Excluir referência

Endpoint da API: https://cip.brapci.inf.br/api/brapci/citedDelete
Endpoint relativo: /api/brapci/citedDelete
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Sim
Autenticação: userAPIKEY ativa obrigatória; validada antes de qualquer alteração.

Variáveis da API

Parâmetros de /api/brapci/citedDelete
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`body`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`
`userAPIKEY`	`body`	`string`	Sim	Token ativo do usuário retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/brapci/citedDelete' --data-urlencode 'idz=ID_ALVO' --data-urlencode 'userAPIKEY=SEU_TOKEN'

Resultado da API

Operação destrutiva: idz é o ID da citação (caId), não o ID RDF do registro. ID inválido retorna status 400. Exemplo ilustrativo baseado no código local; não representa dados de produção. Chave ausente, inválida ou inativa retorna HTTP 401 com status "401" e message "userAPIKEY ausente, invalida ou inativa", sem modificar dados.

{
  "status": "200",
  "message": "Referência deletada com sucesso"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Consultar palavras-chave

Endpoint da API: https://cip.brapci.inf.br/api/brapci/keyword/get
Endpoint relativo: /api/brapci/keyword/get
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/keyword/get
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`query_string`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`

Resultado da API

Alias keywords/get. Exige idz; a ausência resulta em status 500. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Corrigir palavra-chave

Endpoint da API: https://cip.brapci.inf.br/api/brapci/keyword/fix
Endpoint relativo: /api/brapci/keyword/fix
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Sim
Autenticação: APIKEY no parâmetro apikey.

Variáveis da API

Parâmetros de /api/brapci/keyword/fix
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`idz`	`body`	`string`	Sim	Parâmetro idz; consulte as regras da operação.	`—`
`idfix`	`body`	`string`	Sim	Parâmetro idfix; consulte as regras da operação.	`—`
`apikey`	`body`	`string`	Sim	Token do usuário autenticado.	`SEU_TOKEN`

Resultado da API

Alias keywords/fix. Operação de escrita com idz, idfix e apikey; delegada ao módulo keywords. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Metadados e RDF

GET Consultar relação RDF

Endpoint da API: https://cip.brapci.inf.br/api/brapci/data/{ID}
Endpoint relativo: /api/brapci/data/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/data/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

ID identifica id_d. Retorna result com concept, resource e Property. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200",
  "result": {
    "concept": "Conceito ilustrativo",
    "resource": "Literal ilustrativo",
    "Property": "Propriedade"
  }
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Consultar classe RDF

Endpoint da API: https://cip.brapci.inf.br/api/brapci/rdf/get/{ID}
Endpoint relativo: /api/brapci/rdf/get/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/rdf/get/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

Delega a RDFclass::get. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Listar ontologia

Endpoint da API: https://cip.brapci.inf.br/api/brapci/rdf
Endpoint relativo: /api/brapci/rdf
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Retorna Classes, Properties e time. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "200": "Success",
  "time": "2026-09-17T12:00:00",
  "Classes": [],
  "Properties": []
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Índice alfabético

Endpoint da API: https://cip.brapci.inf.br/api/brapci/indexs/{type}/{letter}
Endpoint relativo: /api/brapci/indexs/{type}/{letter}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/indexs/{type}/{letter}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`type`	`path`	`string`	Sim	Parâmetro type; consulte as regras da operação.	`—`
`letter`	`path`	`string`	Sim	Parâmetro letter; consulte as regras da operação.	`—`

Resultado da API

Tipos: subject, author e bodycompany. Letra padrão A; tipo desconhecido retorna status 404. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "data": []
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Alterar idioma de termo

Endpoint da API: https://cip.brapci.inf.br/api/brapci/setTermLang/{ID}/{language}
Endpoint relativo: /api/brapci/setTermLang/{ID}/{language}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/setTermLang/{ID}/{language}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`
`language`	`path`	`string`	Sim	Parâmetro language; consulte as regras da operação.	`—`

Resultado da API

Operação de escrita delegada a RDFliteral::setTermLang. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Operações OAI

Endpoint da API: https://cip.brapci.inf.br/api/brapci/oai/{verb}/{issue}
Endpoint relativo: /api/brapci/oai/{verb}/{issue}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/oai/{verb}/{issue}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`verb`	`path`	`string`	Sim	Parâmetro verb; consulte as regras da operação.	`—`
`issue`	`path`	`string`	Sim	Parâmetro issue; consulte as regras da operação.	`—`

Resultado da API

Delega a Oaipmh/Index::api e acrescenta verb. Verbos e resposta dependem do módulo OAI. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Informações e indicadores

GET Catálogo de serviços

Endpoint da API: https://cip.brapci.inf.br/api/brapci/services
Endpoint relativo: /api/brapci/services
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Também é a resposta padrão de /api/brapci. Retorna services e verb. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200",
  "services": {
    "livros": {
      "name": "Livros",
      "link": "books",
      "icone": "icone",
      "issue": "issue"
    }
  },
  "verb": "services"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Estatísticas da base

Endpoint da API: https://cip.brapci.inf.br/api/brapci/statistics
Endpoint relativo: /api/brapci/statistics
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Retorna diretamente data e update; os totais são textos formatados. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "data": [
    {
      "name": "Indicador ilustrativo",
      "total": "1.000"
    }
  ],
  "update": "2026-09-17"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Resumo das coleções

Endpoint da API: https://cip.brapci.inf.br/api/brapci/resume
Endpoint relativo: /api/brapci/resume
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Retorna publications com contagens por tipo; categorias com zero são omitidas. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "publications": {
    "Revistas": 10
  }
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Notícias

Endpoint da API: https://cip.brapci.inf.br/api/brapci/news
Endpoint relativo: /api/brapci/news
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Delega a Base/News::news. Pode receber dois segmentos adicionais; resposta definida pelo módulo. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Conteúdo institucional

Endpoint da API: https://cip.brapci.inf.br/api/brapci/page/{page}
Endpoint relativo: /api/brapci/page/{page}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/page/{page}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`page`	`path`	`string`	Sim	Parâmetro page; consulte as regras da operação.	`—`

Resultado da API

Páginas como brapci, benancib, brapcilivros, how_index e team. Retorna lista de blocos row e lang. Exemplo ilustrativo baseado no código local; não representa dados de produção.

[
  {
    "row": "<h1>Equipe</h1>",
    "lang": "pt"
  }
]

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Análise de registro

Endpoint da API: https://cip.brapci.inf.br/api/brapci/analysis/{ID}
Endpoint relativo: /api/brapci/analysis/{ID}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/analysis/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`string`	Sim	Parâmetro ID; consulte as regras da operação.	`—`

Resultado da API

Delega a Base/Analysis::analysis. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Atividades

Endpoint da API: https://cip.brapci.inf.br/api/brapci/activities/{action}
Endpoint relativo: /api/brapci/activities/{action}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/activities/{action}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`action`	`path`	`string`	Sim	Parâmetro action; consulte as regras da operação.	`—`

Resultado da API

Delega a Functions/Views::getActivities. Contrato depende da ação. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Contadores

Endpoint da API: https://cip.brapci.inf.br/api/brapci/counter/{action}
Endpoint relativo: /api/brapci/counter/{action}
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/counter/{action}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`action`	`path`	`string`	Sim	Parâmetro action; consulte as regras da operação.	`—`

Resultado da API

Delega a Tools/Counter::counter. Contrato depende da ação. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

GET Identificador de navegação

Endpoint da API: https://cip.brapci.inf.br/api/brapci/setCookie
Endpoint relativo: /api/brapci/setCookie
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Este endpoint não recebe variáveis.

Resultado da API

Retorna o MD5 do cabeçalho Cookie ou de data/hora quando não há cookie. Não estabelece autenticação. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200",
  "cookie": "hash ilustrativo"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Manutenção e envio

POST Registrar problema

Endpoint da API: https://cip.brapci.inf.br/api/brapci/bug
Endpoint relativo: /api/brapci/bug
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/bug
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`id`	`body`	`string`	Sim	Parâmetro id; consulte as regras da operação.	`—`
`bugs`	`body`	`string`	Sim	Parâmetro bugs; consulte as regras da operação.	`—`

Resultado da API

Operação de escrita: registra um problema associado ao ID. Exemplo não disponível: contrato delegado, sem resposta verificada.

null

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

POST Enviar arquivo

Endpoint da API: https://cip.brapci.inf.br/api/brapci/upload
Endpoint relativo: /api/brapci/upload
Content-Type: application/json (ver ressalvas na descrição)
Precisa de APIKEY?: Não
Autenticação: O despachante inspecionado não valida APIKEY nesta ação; controles adicionais podem existir no módulo delegado.

Variáveis da API

Parâmetros de /api/brapci/upload
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`file`	`body`	`file`	Sim	Parâmetro file; consulte as regras da operação.	`—`

Resultado da API

Recebe file em multipart/form-data. A função upload monta uma resposta, mas o despachante atual não atribui seu retorno a RSP: não confiar nos detalhes do retorno. Exemplo ilustrativo baseado no código local; não representa dados de produção.

{
  "status": "200"
}

Variáveis de retorno

Este endpoint não retorna conteúdo documentado.

Small World

Consulta o menor caminho de colaboração entre dois autores cadastrados na Brapci.

GET /tools/dijkstra

Endpoint da API: https://cip.brapci.inf.br/api/tools/dijkstra
Endpoint relativo: /tools/dijkstra
Content-Type: application/json
Precisa de APIKEY?: Não — O endpoint não exige APIKEY para consulta pública.

Variáveis da API

Parâmetros de /tools/dijkstra
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`source`	`query_string`	`string`	Sim	Nome completo do autor de origem, previamente selecionado no autocomplete de autores.	`Rene Faustino Gabriel Junior`
`target`	`query_string`	`string`	Sim	Nome completo do autor de destino, previamente selecionado no autocomplete de autores.	`Rene Faustino Gabriel Junior`

Exemplo de requisição

https://cip.brapci.inf.br/api/tools/dijkstra?source=Rene%20Faustino%20Gabriel%20Junior&target=Rene%20Faustino%20Gabriel%20Junior

Resultado da API

Objeto JSON com o caminho encontrado, a distância entre os autores e os nomes de origem e destino.

{
  "path": [
    {
      "step": 1,
      "node": "Rene Faustino Gabriel Junior"
    }
  ],
  "distance": 0,
  "origin": "Rene Faustino Gabriel Junior",
  "target": "Rene Faustino Gabriel Junior"
}

Variáveis de retorno

Campos retornados por /tools/dijkstra
Nome	Tipo	Descrição
`path`	`array<object>`	Sequência ordenada dos autores que formam o caminho de colaboração.
`path[].step`	`integer`	Posição do autor dentro do caminho retornado.
`path[].node`	`string`	Nome do autor correspondente à etapa do caminho.
`distance`	`integer`	Número de conexões entre o autor de origem e o autor de destino.
`origin`	`string`	Nome do autor de origem reconhecido pela API.
`target`	`string`	Nome do autor de destino reconhecido pela API.

Gênero — Genere::index

Documentação de App\Models\Api\Endpoint\Genere::index($d1 = '', $d2 = '', $d3 = ''). A rota /api/gender é encaminhada pelo Api\Index para essa classe: $d1 recebe gender, $d2 seleciona check_genere quando esse segmento está presente e $d3 não é usado. Os argumentos posicionais são definidos pelo roteamento, não são parâmetros query. As operações são públicas, sem APIKEY. A identificação por nome é uma estimativa baseada em frequências, não uma confirmação do gênero da pessoa. A operação check_genere lê hasGender em RDF2/rdf_literal, usa o nome como alternativa e não grava dados. O resumo /api/pq utiliza essa operação para bs_genero ausente e salva M/F/X na tabela bolsistas somente quando bs_genero é NULL. A atualização usa id_bs e bs_genero IS NULL. Valores vazios ou com espaços são preenchidos apenas na resposta; valores cadastrados são preservados.

GET Identificar gênero por RDF ou nome

Endpoint da API: https://cip.brapci.inf.br/api/gender/check_genere
Endpoint relativo: /api/gender/check_genere
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY.
Método no serviço: App\Models\Api\Endpoint\Genere::index('gender', 'check_genere', '')

Variáveis da API

Parâmetros de /api/gender/check_genere
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`rdf`	`query_string`	`integer positivo`	Não	ID RDF da pessoa. Pelo menos rdf positivo ou name não vazio deve ser informado. Consulta os valores hasGender antes de recorrer ao nome.	`12345`
`name`	`query_string`	`string`	Não	Nome da pessoa, usado quando o RDF não identifica M/F. Se informado somente rdf e não houver gênero definido, retorna X.	`Nome de exemplo`

Exemplo de requisição

curl --get "https://cip.brapci.inf.br/api/gender/check_genere" --data-urlencode "name=Nome de exemplo"

curl "https://cip.brapci.inf.br/api/gender/check_genere?rdf=12345"

fetch("https://cip.brapci.inf.br/api/gender/check_genere?name=" + encodeURIComponent("Nome de exemplo"))
  .then(response => response.json())
  .then(result => console.log(result.status, result.gender));

Resultado da API

Objeto JSON com status lógico e código de gênero: M, F ou X (indefinido). RDF: maioria estrita de M/F em relação às demais categorias; empates ou falta de dados resultam em X e permitem o fallback por nome. A identificação por nome usa o classificador existente e seu limiar superior a 90%. Parâmetros inválidos ou ausência de nome e RDF positivo retornam HTTP 422 com {status:'422', message:'Informe name ou rdf válidos.'}. Exemplo ilustrativo.

{
  "status": "200",
  "gender": "X"
}

Variáveis de retorno

Campos retornados por /api/gender/check_genere
Nome	Tipo	Descrição
`status`	`string`	200 para consulta concluída; 422 para entrada inválida.
`gender`	`string`	M: masculino; F: feminino; X: indefinido. Presente em consultas concluídas.
`message`	`string (opcional)`	Descrição da validação em respostas de erro.

GET Identificar gênero pelo nome — /api/gender

Endpoint da API: https://cip.brapci.inf.br/api/gender
Endpoint relativo: /api/gender
Content-Type: text/plain (corpo legado; cabeçalho atual application/json)
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY.
Método no serviço: App\Models\Api\Endpoint\Genere::index('gender', '', '') → getGenere(name)

Variáveis da API

Parâmetros de /api/gender
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`name`	`query_string`	`string`	Não	Nome a identificar. Sem nome, o backend usa NaN.	`Nome de exemplo`
`debug`	`query_string`	`string`	Não	Somente no endpoint por nome: qualquer valor não vazio ativa saída de diagnóstico, podendo adicionar HTML ao corpo. Omitir nas integrações. Na operação check_genere, o diagnóstico está desativado.	`1`

Exemplo de requisição

curl --get "https://cip.brapci.inf.br/api/gender" --data-urlencode "name=Nome de exemplo"

fetch("https://cip.brapci.inf.br/api/gender?name=" + encodeURIComponent("Nome de exemplo"))
  .then(response => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.text(); })
  .then(gender => console.log(gender));

Resultado da API

Retorna texto sem aspas JSON: masculino, feminino ou indefinido. Consumir com response.text(), e não response.json(). Este endpoint legado identifica pelo nome; a operação /check_genere combina RDF e nome. Exemplo ilustrativo.

"indefinido"

Variáveis de retorno

Campos retornados por /api/gender
Nome	Tipo	Descrição
`corpo`	`string`	masculino, feminino ou indefinido.

Curtidas

Consulta e atualização da curtida de um registro por usuário: /api/like/{action}/{ID}.

POST Consultar curtida

Endpoint da API: https://cip.brapci.inf.br/api/like/getLike/{ID}
Endpoint relativo: /api/like/getLike/{ID}
Content-Type: JSON (o backend atual não define explicitamente Content-Type)
Precisa de APIKEY?: Sim
Autenticação: Token/APIKEY do usuário no campo user do corpo da requisição.

Variáveis da API

Parâmetros de /api/like/getLike/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`integer`	Sim	Identificador do registro Brapci.	`466086`
`id`	`body`	`integer`	Sim	Mesmo identificador informado na URL; obrigatório na implementação atual.	`466086`
`user`	`body`	`string`	Sim	Token/APIKEY retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/like/getLike/466086' --data-urlencode 'id=466086' --data-urlencode 'user=SEU_TOKEN'

Resultado da API

liked igual a 1 ou "1" indica curtida; 0 ou "0" indica coração vazado.

{
  "liked": 1
}

Variáveis de retorno

Campos retornados por /api/like/getLike/{ID}
Nome	Tipo	Descrição
`liked`	`number\|string`	1: curtido; 0: não curtido ou usuário não encontrado.

POST Curtir registro

Endpoint da API: https://cip.brapci.inf.br/api/like/liked/{ID}
Endpoint relativo: /api/like/liked/{ID}
Content-Type: JSON (o backend atual não define explicitamente Content-Type)
Precisa de APIKEY?: Sim
Autenticação: Token/APIKEY do usuário no campo user do corpo da requisição.

Variáveis da API

Parâmetros de /api/like/liked/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`integer`	Sim	Identificador do registro Brapci.	`466086`
`id`	`body`	`integer`	Sim	Mesmo identificador informado na URL; obrigatório na implementação atual.	`466086`
`user`	`body`	`string`	Sim	Token/APIKEY retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/like/liked/466086' --data-urlencode 'id=466086' --data-urlencode 'user=SEU_TOKEN'

Resultado da API

Sucesso: status "200". Usuário inválido: {"status":"500","message":"Usuário inválido (apikey)"}. Só altere o coração após confirmação de sucesso.

{
  "status": "200",
  "message": "Success - Marked 466086"
}

Variáveis de retorno

Campos retornados por /api/like/liked/{ID}
Nome	Tipo	Descrição
`status`	`string`	"200": sucesso; "500": usuário inválido.
`message`	`string`	Descrição do resultado da operação.

POST Descurtir registro

Endpoint da API: https://cip.brapci.inf.br/api/like/disliked/{ID}
Endpoint relativo: /api/like/disliked/{ID}
Content-Type: JSON (o backend atual não define explicitamente Content-Type)
Precisa de APIKEY?: Sim
Autenticação: Token/APIKEY do usuário no campo user do corpo da requisição.

Variáveis da API

Parâmetros de /api/like/disliked/{ID}
Nome	Local	Tipo	Obrigatória	Descrição	Exemplo
`ID`	`path`	`integer`	Sim	Identificador do registro Brapci.	`466086`
`id`	`body`	`integer`	Sim	Mesmo identificador informado na URL; obrigatório na implementação atual.	`466086`
`user`	`body`	`string`	Sim	Token/APIKEY retornado pelo login.	`SEU_TOKEN`

Exemplo de requisição

curl -X POST 'https://cip.brapci.inf.br/api/like/disliked/466086' --data-urlencode 'id=466086' --data-urlencode 'user=SEU_TOKEN'

Resultado da API

Sucesso: status "200". Usuário inválido: {"status":"500","message":"Usuário inválido (apikey)"}. Só altere o coração após confirmação de sucesso.

{
  "status": "200",
  "message": "Success - Dismarked 466086"
}

Variáveis de retorno

Campos retornados por /api/like/disliked/{ID}
Nome	Tipo	Descrição
`status`	`string`	"200": sucesso; "500": usuário inválido.
`message`	`string`	Descrição do resultado da operação.

PQ — Bolsas de Produtividade em Pesquisa

API pública utilizada pelo painel /pq. Fornece bolsas, instituições, distribuição por ano de início e histórico de concessões. O frontend consulta https://cip.brapci.inf.br/api/pq mesmo quando executado em localhost:4200. As consultas não recebem filtros nem paginação: busca por nome, filtros por nível, instituições, regiões e mapa são calculados no navegador. O parâmetro type é lido pelo backend, mas não altera o resultado. As contagens representam registros de bolsas, não necessariamente pesquisadores únicos. IDs podem chegar como strings. Datas usam YYYY-MM-DD. Coleções vazias podem ser [] mesmo quando normalmente são objetos indexados por ano. A rota vigente não está incluída porque o código chama collections() em Bolsas, método não implementado nesse modelo. No resumo /api/pq, bs_genero ausente (nulo, vazio ou somente espaços) é identificado na resposta por /api/gender/check_genere: primeiro RDF, depois nome. Os códigos são M, F e X (indefinido). Quando bs_genero é NULL, /api/pq salva o resultado em bolsistas pelo id_bs, com condição bs_genero IS NULL para preservar valores cadastrados. O endpoint /actives continua retornando os valores cadastrados.

GET Resumo do painel PQ

Endpoint da API: https://cip.brapci.inf.br/api/pq
Endpoint relativo: /api/pq
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY ou sessão de login.
Método no serviço: PqPage.loadData() — HttpClient.get<PqResponse>()

Variáveis da API

Este endpoint não recebe variáveis.

Exemplo de requisição

curl "https://cip.brapci.inf.br/api/pq"

fetch("https://cip.brapci.inf.br/api/pq")
  .then(response => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.json(); })
  .then(data => console.log(data));

Resultado da API

Objeto com status lógico '200', mensagem 'Resume', quantidade de bolsas e instituições distintas (BS_IES após trim), lista de bolsas e históricos. data inclui somente bolsas com bs_start <= data atual do servidor e bs_finish >= essa mesma data, incluindo os dias de início e término. actives_by_year agrupa o histórico com início anterior à data atual por ano de início e modalidade + nível; não é uma contagem de todas as bolsas vigentes em cada ano. applications classifica, por pesquisador, primeira concessão, reconcessão com continuidade até um dia após o término anterior e nova concessão após interrupção. O campo status é do JSON e não substitui o status HTTP. Exemplo ilustrativo com dados fictícios.

{
  "status": "200",
  "message": "Resume",
  "actives": 1,
  "institutions": 1,
  "data": [
    {
      "id_bb": "100",
      "bb_person": "10",
      "bs_nome": "Pesquisador de exemplo",
      "bs_nivel": "2",
      "bs_start": "2025-03-01",
      "bs_finish": "2028-02-29",
      "BS_IES": "UFRGS",
      "bs_lattes": "0000000000000000",
      "bs_rdf_id": "12345",
      "bd_brapci": "12345",
      "mod_sigla": "PQ",
      "mod_descricao": "Produtividade em Pesquisa",
      "bs_tipo": "1",
      "bs_ativo": "1",
      "bs_genero": "F"
    }
  ],
  "actives_by_year": {
    "2025": {
      "PQ2": 1
    }
  },
  "applications": {
    "2025": {
      "novas": [
        {
          "id_bb": "12345",
          "nome": "Pesquisador de exemplo",
          "nivel": "2",
          "ies": "UFRGS",
          "inicio": "2025-03-01",
          "fim": "2028-02-29",
          "tipo": "nova",
          "bs_genero": "F"
        }
      ],
      "reconcedidas": [],
      "novas_apos_interrupcao": []
    }
  }
}

Variáveis de retorno

Campos retornados por /api/pq
Nome	Tipo	Descrição
`status`	`string`	Status lógico da resposta; no resumo, '200'.
`message`	`string`	Mensagem do resumo: 'Resume'.
`actives`	`integer`	Número de registros retornados em data.
`institutions`	`integer`	Quantidade de siglas BS_IES distintas após trim.
`data`	`array<object>`	Bolsas vigentes: bs_start <= data atual do servidor e bs_finish >= essa mesma data, com dados do bolsista e modalidade.
`data[].id_bb`	`string \| integer`	Identificador da bolsa.
`data[].bb_person`	`string \| integer`	Identificador interno do bolsista.
`data[].bs_nome`	`string`	Nome do pesquisador.
`data[].bs_nivel`	`string`	Nível da bolsa, como 1A, 1B, 1C, 1D ou 2.
`data[].bs_start`	`string (YYYY-MM-DD)`	Data de início da bolsa.
`data[].bs_finish`	`string (YYYY-MM-DD)`	Data de término da bolsa.
`data[].BS_IES`	`string`	Sigla da instituição; o nome do campo usa maiúsculas.
`data[].bs_lattes`	`string`	Identificador do currículo Lattes.
`data[].bs_rdf_id`	`string \| integer`	Identificador do pesquisador na Brapci.
`data[].bd_brapci`	`string \| integer \| null`	Vínculo adicional com a Brapci, quando cadastrado.
`data[].mod_sigla`	`string`	Sigla da modalidade.
`data[].mod_descricao`	`string`	Descrição da modalidade.
`data[].bs_tipo`	`string \| integer`	Identificador da modalidade.
`data[].bs_ativo`	`string \| integer`	Indicador cadastral da bolsa; não é o filtro usado por activesPQ().
`actives_by_year`	`object \| array`	Mapa ano de início → modalidade concatenada ao nível → quantidade; histórico com bs_start anterior à data atual.
`applications`	`object \| array`	Mapa ano de início → novas, reconcedidas e novas_apos_interrupcao.
`applications.{ano}.novas`	`array<object>`	Primeiras concessões no histórico disponível.
`applications.{ano}.reconcedidas`	`array<object>`	Concessões com início até um dia após o término da anterior, incluindo sobreposição.
`applications.{ano}.novas_apos_interrupcao`	`array<object>`	Concessões cujo início excede esse limite de continuidade.
`applications.{ano}.{categoria}[].id_bb`	`string \| integer \| null`	Apesar do nome, preenchido com bs_rdf_id da concessão atual; não confundir com data[].id_bb.
`applications.{ano}.{categoria}[].nome`	`string \| null`	Nome do pesquisador.
`applications.{ano}.{categoria}[].nivel`	`string`	Nível da bolsa.
`applications.{ano}.{categoria}[].ies`	`string \| null`	Sigla da instituição.
`applications.{ano}.{categoria}[].inicio`	`string (YYYY-MM-DD)`	Início da concessão.
`applications.{ano}.{categoria}[].fim`	`string (YYYY-MM-DD)`	Término da concessão.
`applications.{ano}.{categoria}[].tipo`	`string`	nova, reconcedida ou nova_apos_interrupcao.
`applications.{ano}.{categoria}[].bolsa_anterior`	`object (opcional)`	Nas concessões posteriores à primeira: id_bb (ID da bolsa anterior), nivel, inicio e fim.
`applications.{ano}.{categoria}[].dias_interrupcao`	`integer (opcional)`	Dias entre as concessões descontando o dia de início; zero para sobreposição.
`data[].bs_genero`	`string \| null`	Valor do campo bs_genero da tabela bolsistas, sem conversão. Quando ausente no cadastro, o resumo retorna a identificação calculada (M/F/X), O resumo salva em bolsistas somente quando o campo original é NULL; vazios e espaços continuam sendo preenchidos apenas na resposta.
`applications.{ano}.{categoria}[].bs_genero`	`string \| null`	Gênero cadastrado em bolsistas; incluído na exportação CSV de concessões. Sem valor, a célula do CSV fica vazia. Quando ausente no cadastro, o resumo retorna a identificação calculada (M/F/X), O resumo salva em bolsistas somente quando o campo original é NULL; vazios e espaços continuam sendo preenchidos apenas na resposta.

GET Listar bolsas vigentes

Endpoint da API: https://cip.brapci.inf.br/api/pq/actives
Endpoint relativo: /api/pq/actives
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY ou sessão de login.

Variáveis da API

Este endpoint não recebe variáveis.

Exemplo de requisição

curl "https://cip.brapci.inf.br/api/pq/actives"

fetch("https://cip.brapci.inf.br/api/pq/actives")
  .then(response => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.json(); })
  .then(data => console.log(data));

Resultado da API

Array direto, sem envelope status/data. Retorna somente bolsas com bs_start <= data atual do servidor e bs_finish >= essa mesma data. Os dias de início e término são incluídos; bolsas futuras e encerradas são excluídas. Exemplo ilustrativo com dados fictícios.

[
  {
    "id_bb": "100",
    "bb_person": "10",
    "bs_nome": "Pesquisador de exemplo",
    "bs_nivel": "2",
    "bs_start": "2025-03-01",
    "bs_finish": "2028-02-29",
    "BS_IES": "UFRGS",
    "bs_lattes": "0000000000000000",
    "bs_rdf_id": "12345",
    "bd_brapci": "12345",
    "mod_sigla": "PQ",
    "mod_descricao": "Produtividade em Pesquisa",
    "bs_tipo": "1",
    "bs_ativo": "1",
    "bs_genero": "F"
  }
]

Variáveis de retorno

Campos retornados por /api/pq/actives
Nome	Tipo	Descrição
`[].id_bb`	`string \| integer`	Identificador da bolsa.
`[].bb_person`	`string \| integer`	Identificador interno do bolsista.
`[].bs_nome`	`string`	Nome do pesquisador.
`[].bs_nivel`	`string`	Nível da bolsa, como 1A, 1B, 1C, 1D ou 2.
`[].bs_start`	`string (YYYY-MM-DD)`	Data de início da bolsa.
`[].bs_finish`	`string (YYYY-MM-DD)`	Data de término da bolsa.
`[].BS_IES`	`string`	Sigla da instituição; o nome do campo usa maiúsculas.
`[].bs_lattes`	`string`	Identificador do currículo Lattes.
`[].bs_rdf_id`	`string \| integer`	Identificador do pesquisador na Brapci.
`[].bd_brapci`	`string \| integer \| null`	Vínculo adicional com a Brapci, quando cadastrado.
`[].mod_sigla`	`string`	Sigla da modalidade.
`[].mod_descricao`	`string`	Descrição da modalidade.
`[].bs_tipo`	`string \| integer`	Identificador da modalidade.
`[].bs_ativo`	`string \| integer`	Indicador cadastral da bolsa; não é o filtro usado por activesPQ().
`[].bs_genero`	`string \| null`	Valor do campo bs_genero da tabela bolsistas, sem conversão.

GET Quantidade de bolsas por ano

Endpoint da API: https://cip.brapci.inf.br/api/pq/bolsa_ano
Endpoint relativo: /api/pq/bolsa_ano
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY ou sessão de login.

Variáveis da API

Este endpoint não recebe variáveis.

Exemplo de requisição

curl "https://cip.brapci.inf.br/api/pq/bolsa_ano"

fetch("https://cip.brapci.inf.br/api/pq/bolsa_ano")
  .then(response => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.json(); })
  .then(data => console.log(data));

Resultado da API

Mapa ano → quantidade, considerando registros com bs_ativo = 1. Percorre anos do início até antes do ano de término e até o ano atual do servidor. A implementação limita o percurso a 12 anos por bolsa; por isso não equivale à distribuição actives_by_year do resumo. Exemplo ilustrativo com dados fictícios.

{
  "2024": 2,
  "2025": 3
}

Variáveis de retorno

Campos retornados por /api/pq/bolsa_ano
Nome	Tipo	Descrição
`{ano}`	`integer`	Quantidade de bolsas contadas no ano; o ano de término não é incluído.

GET Distribuição anual por nível

Endpoint da API: https://cip.brapci.inf.br/api/pq/bolsa_ano_tipo
Endpoint relativo: /api/pq/bolsa_ano_tipo
Content-Type: application/json
Precisa de APIKEY?: Não
Autenticação: Consulta pública, sem APIKEY ou sessão de login.

Variáveis da API

Este endpoint não recebe variáveis.

Exemplo de requisição

curl "https://cip.brapci.inf.br/api/pq/bolsa_ano_tipo"

fetch("https://cip.brapci.inf.br/api/pq/bolsa_ano_tipo")
  .then(response => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.json(); })
  .then(data => console.log(data));

Resultado da API

Objeto label/data para gráficos. label lista anos de 1990 até o ano atual do servidor. data usa bs_nivel como chave (apesar do nome da rota, não usa a modalidade). Cada array acompanha os índices de label. Considera bs_ativo = 1 e exclui o ano de término. A implementação limita o percurso a 12 anos por bolsa. O exemplo vazio mostra o formato quando não há níveis com registros. Exemplo ilustrativo com dados fictícios.

Variáveis de retorno

Campos retornados por /api/pq/bolsa_ano_tipo
Nome	Tipo	Descrição
`label`	`array<integer>`	Anos de 1990 até o ano atual do servidor, em ordem crescente.
`data`	`object \| array`	Mapa nível → array de contagens; sem registros, pode retornar [].
`data.{nivel}`	`array<integer>`	Contagens alinhadas por índice aos anos em label.

Documentação da API

Filtros da documentação

GET Consultar página institucional (about)

Variáveis da API

Exemplo de requisição

Resultado da API

Variáveis de retorno

GET Consultar sessão

Variáveis da API

Resultado da API

Variáveis de retorno

POST Cadastrar usuário

Variáveis da API

Resultado da API

Variáveis de retorno

POST Encerrar sessão

Variáveis da API

Resultado da API

Variáveis de retorno

GET Solicitar recuperação de senha

Variáveis da API

Resultado da API

Variáveis de retorno

POST Login legado

Variáveis da API

Resultado da API

Variáveis de retorno

POST Callback OAuth legado

Variáveis da API

Resultado da API

Variáveis de retorno

POST Cadastro social legado

Variáveis da API

Resultado da API

Variáveis de retorno

POST Contato social legado

Variáveis da API

Resultado da API

Variáveis de retorno

POST Recuperação de senha legada

Variáveis da API

Resultado da API

Variáveis de retorno

POST Login OAuth legado

Variáveis da API

Resultado da API

Variáveis de retorno

Busca e recuperação

GET Buscar registros

Variáveis da API

Resultado da API

Variáveis de retorno

GET Consultar registro

Variáveis da API

Resultado da API

Variáveis de retorno

GET Recuperar referências selecionadas

Variáveis da API

Resultado da API

Variáveis de retorno

GET Exportar seleção

Variáveis da API

Resultado da API

Variáveis de retorno

GET Obter texto completo

Variáveis da API

Resultado da API

Variáveis de retorno

Fontes, fascículos e livros

GET Listar fontes

Variáveis da API

Resultado da API

Variáveis de retorno

GET Consultar fascículo

Variáveis da API

Resultado da API

Variáveis de retorno

GET Consultar fascículo detalhado

Variáveis da API

Resultado da API