LattesExtrator

De BrapciWiki
Ir para navegação Ir para pesquisar

WEB SERVICE DE EXTRAÇÃO DE CURRÍCULOS

Introdução

O Web Service de Extração de Currículo foi desenvolvido para automatizar a extração de currículos pelas Instituições interessadas em ter uma versão do Currículo Lattes de seus professores e alunos.As configurações necessárias para acesso ao serviço e recuperação dos dados estão descritas a seguire devem ser repassadas ao setor de informática da sua instituição para que sejam tomadas as devidas providências.

Descrição do serviço

Para ter acesso ao serviço, a instituição deve informar um endereço IP de onde partirão as requisições e somente esse IP terá permissão para extrair os currículos.O serviço utiliza o protocolo SOAP sobre HTTP, e é recomendado que as requisições sejam feitas utilizando HTTPS para maior segurança. Futuramente o CNPq poderá bloquear as requisições que utilizarem HTTP.Abaixo temos a descrição dos 2 (dois) serviços de extração de currículos disponíveis:

WEB SERVICE DE EXTRAÇÃO DE CURRÍCULOS

Introdução

O Web Service de Extração de Currículo foi desenvolvido para automatizar a extração de currículos pelas Instituições interessadas em ter uma versão do Currículo Lattes de seus professores e alunos.As configurações necessárias para acesso ao serviço e recuperação dos dados estão descritas a seguire devem ser repassadas ao setor de informática da sua instituição para que sejam tomadas as devidas providências.

Descrição do serviço

Para ter acesso ao serviço, a instituição deve informar um endereço IP de onde partirão as requisições e somente esse IP terá permissão para extrair os currículos.O serviço utiliza o protocolo SOAP sobre HTTP, e é recomendado que as requisições sejam feitas utilizando HTTPS para maior segurança. Futuramente o CNPq poderá bloquear as requisições que utilizarem HTTP.Abaixo temos a descrição dos 2 (dois) serviços de extração de currículos disponíveis:

svrcurriculo

Abaixo está o WSDL do serviço:

http://servicosweb.cnpq.br/srvcurriculo/WSCurriculo?wsdl

O serviço de extração de currículos utiliza o protocolo SOAP.No WSDL estão definidos os métodos disponíveis, além dos parâmetros e retornos de cada um deles. Segue uma breve descrição de cada um:


getCurriculoCompactado

parâmetro:

-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: 
http://lattes.cnpq.br/0000000000000000

retorno:

-representação em base64 de um arquivo.ZIP contendo o Currículo Lattes em formato XML.

getCurriculoCompactadoPorUsuario

parâmetros:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000-login: o nome de login criado no momento do cadastro deverá ser utilizado no caso deinstituições que compartilham IP. É necessário para que o serviço saiba qual aplicação está utilizando o IP durante uma requisição .retorno:-representação em base64 de um arquivo.ZIP contendo o Currículo Lattes em formato XML.

getDataAtualizacaoCV

parâmetro:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000 retorno:-A data de atualização do currículo no formato dd/MM/aaaa hh:mm:ss deve ser utilizada para extrair somente os currículos que sofreram atualização, evitando cargas completas da base sem necessidade. legenda:dd = diaMM = mêsaaaaa = anohh = horamm = minutos ss = segundos

getDataAtualizacaoCVPorUsuario

parâmetros:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000-login: o nome de login criado no momento do cadastro deverá ser utilizado no caso deinstituições que compartilham IP. É necessário para que o serviço saiba qual aplicação estáutilizando o IP durante uma requisição .retorno:-A data de atualização do currículo no formato dd/MM/aaaa hh:mm:ss(legenda acima), deve ser utilizada para extrair somente os currículos que sofreram atualização, evitando cargas completas da base sem necessidade.

getOcorrenciaCV

parâmetros:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000 retorno:-uma descrição do que ocorreu quando um currículo não foi retornado pelo serviço.00 -Currículo recuperado com sucesso!;01 -CPF não informado!;02 -Nome de Estrangeiro não informado!;03 -Data de nascimento não informada!;04 -Nenhum currículo encontrado!;05 -Mais de um currículo atende ao critério informado!;06 -CPF inválido!;07 -Cliente com IP sem permissão!;99 -Erro não previsto!;


getOcorrenciaCVPorUsuario

parâmetros:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000-login: o nome de login criado no momento do cadastro deverá ser utilizado no caso deinstituições que compartilham IP. É necessário para que o serviço saiba qual aplicação está utilizando o IP durante uma requisição .retorno:-uma descrição do que ocorreu quando um currículo não foi retornado pelo serviço (veja lista das mensagens acima).


getIdentificadorCNPq

(para esse método, deverá ser informado o CPF ou o conjunto).nomeCompleto+dataNascimento).

parâmetros:-cpf-nomeCompleto-dataNascimentoo IP durante uma requisição .retorno:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/0000000000000000


getIdentificadorCNPqPorUsuario

(para esse método, deverá ser informado o CPF ou o conjunto nomeCompleto+dataNascimento.

parâmetros:-cpf-nomeCompleto -dataNascimento-login: o nome de login criado no momento do cadastro deverá ser utilizado no caso deinstituições que compartilham IP. É necessário para que o serviço saiba qual aplicação está utilizando o IP durante uma requisição .retorno:-id: IdCNPQ, o identificador de um currículo no CNPq. É o mesmo utilizado no final da URL para o currículo Lattes, exemplo: http://lattes.cnpq.br/00000000000000002.2.wsmodulocvCaminho do wsdl:http://servicosweb.cnpq.br/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImpl?wsdlPermite a extração de trechos de um currículo específico, ou seja, um subconjunto das informações do Currículo Lattes. Além de informar quais os elementos serão extraídos, também é possível especificar um período (ano de início e ano de término) e os elementos retornados serão os produzidos no período informado.


getItensDisponiveis

parâmetros: não háRetorno: uma lista de elementos que podem ser passadoscomo parâmetro para o método “extrairItens”, que retornará somente os itens informados.


extrairItens

parâmetros:

  • anoInicio:
  • anofinal do período do qual serão retornadas os elementos do currículo;-anoTermino: ano final do período do qual serão retornadas os elementos do currículo;-idCNPq: identificador do currículo que será recuperado;-listaIdModuloItem: lista de elementos que deverão ser retornados. Retorno:-XML do currículo com os itens/módulos selecionados na passagem de parâmetros.

Observação 1: Os anos de início e término são considerados como dentro do intervalo de recuperação do período. Observação 2: Caso deseje retornar as produções de apenas um ano específico, informe os dois anos iguais. Exemplo: anoInicio=”2010” e anoTermino=”2010” retornarão as produções de 2010. Observação 3: Todos os parâmetros são obrigatórios. Observação 4: Se for informado um superconjunto de elementos como parâmetro o serviço retornará todos os elementos que pertencem a esse superconjunto. Por exemplo, informando PRODUCAO-BIBLIOGRAFICA, o serviço retornará artigos publicados, textos em jornais e revistas, livros e capítulos de livros, etc. Para saber quais elementos estão contidos em um “superconjunto”, vejam a estrutura do XSD.

Retorno: uma lista de elementos que podem ser passados como parâmetro para o método “extrairItens”, que retornará somente os itens informados.

Regras para acesso

Abaixo as condições de acesso:

  • A requisição deve partir do endereço IP da instituição.
  • A [SUA INSTITUIÇÃO] estar cadastrada com a permissão para extrair todos os currículos que:-Apresentar cadastro de alguma formação acadêmica na [SUA INSTITUIÇÃO] ou alguma de suas subunidades, OU;-Ter cadastro de alguma atuação ou vínculo profissional ATUAL com a [SUA INSTITUIÇÃO] ou alguma de suas subunidades, OU;-Ter o endereço profissional da [SUA INSTITUIÇÃO] ou alguma de suas subunidades.-Em alguns casos, quando o usuário não encontra a instituição que deseja na busca durante o cadastro do currículo, ele tem a opção de inserir a instituição desejada, só que essa instituição só é visível dentro do currículo do usuário, portanto não é considerada uma instituição real. O serviço de extração considera essa instituição como subunidade da [SUA INSTITUIÇÃO] se o nome e sigla forem similares aos de alguma subunidade da [SUA INSTITUIÇÃO] que esteja cadastrada no Diretório de Instituições –DI (http://di.cnpq.br/di).

Gerando o cliente

svrcurriculo

Ao gerar o cliente (utilizando ferramentas que criam o cliente a partir do WDSL) que acessa o serviço é necessário verificar se o endereço do ENDPOINT está apontando para o servidor “servicosweb.cnpq.br” .O endereço do ENDPOINT abaixo:http://[ENDERECO_IP]:8080/srvcurriculo/WSCurriculoDeverá ser alterado para:http://servicosweb.cnpq.br/srvcurriculo/WSCurriculoNo WSDL o elemento que contém o endereço que deve ser alterado é:<soap:address location="http://[ENDERECO_IP]:8080/srvcurriculo/WSCurriculo"/>4.2.wsmodulocvAo gerar o cliente (utilizando ferramentas que criam o cliente a partir do WDSL) que acessa o serviço é necessário verificar se o endereço do ENDPOINT está apontando para o servidor “servicosweb.cnpq.br” .O endereço do ENDPOINT abaixo:http://[ENDERECO_IP]:8080/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImplDeverá ser alterado para:http://servicosweb.cnpq.br/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImplNo WSDL o elemento que contém o endereço que deve ser alterado é:<soap:address location="http://[ENDERECO_IP]:8080/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImpl"/>

Gerando o cliente

svrcurriculo

Ao gerar o cliente (utilizando ferramentas que criam o cliente a partir do WDSL) que acessa o serviço é necessário verificar se o endereço do ENDPOINT está apontando para o servidor “servicosweb.cnpq.br” .O endereço do ENDPOINT abaixo:http://[ENDERECO_IP]:8080/srvcurriculo/WSCurriculoDeverá ser alterado para:http://servicosweb.cnpq.br/srvcurriculo/WSCurriculoNo WSDL o elemento que contém o endereço que deve ser alterado é:<soap:address location="http://[ENDERECO_IP]:8080/srvcurriculo/WSCurriculo"/>4.2.wsmodulocvAo gerar o cliente (utilizando ferramentas que criam o cliente a partir do WDSL) que acessa o serviço é necessário verificar se o endereço do ENDPOINT está apontando para o servidor “servicosweb.cnpq.br” .O endereço do ENDPOINT abaixo:http://[ENDERECO_IP]:8080/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImplDeverá ser alterado para:http://servicosweb.cnpq.br/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImplNo WSDL o elemento que contém o endereço que deve ser alterado é:<soap:address location="http://[ENDERECO_IP]:8080/wsmodulocv/WSExtracaoCVLattesService/WSExtracaoCVLattesImpl"/>