Referência rápida
Lista dos EndPoints e dos Parâmetros para GET e POST!
5 minute read
Formato da API
base-URL + ‘/api/v0/’ + endpoint + ‘?’ + request-parametersExemplo para o Taxons endpoint
https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit=2&offset=10OBTER DADOS - GET
Parâmetros GET compartilhados
Quando múltiplos parâmetros são especificados eles são combinados com o operador AND. Não há opção de parâmetro OR nas suas buscas.
Todos os endpoints compartilham estes parâmetros GET:
idretorna apenas o recurso especificado. Pode ser um número ou uma lista delimitada por vírgulas, comoapi/v0/locations? Id = 1,50,124limit: limita o número de itens que devem ser retornados (deve ser maior que 0). Exemplo:api/v0/taxons?limit=10offset: o registro inicial a partir do qual deseja extrair, para ser usado com limite ao tentar baixar uma grande quantidade de dados. Exemplo:api/v0/taxons?offset=1000&limit=10retorna 10 registros começando da posição 1K da consulta realizada.fields: o campo ou campos que devem ser retornados. Cada EndPoint possui seus próprios campos, mas há duas palavras especiais, simple (padrão) e all, que retornam diferentes coleções de campos.fields = allpode retornar sub-objetos para cada objeto.fields ='raw'irá retornar a tabela bruta, e isso torna a busca muito mais rápida, embora será mais difícil interpretar alguns valores. Exemplo:api/v0/taxons?fields='id,scientificName,valid'save_job: usandosave_job=1na lista de parâmetros, será gerado um job com a sua busca e os dados poderão ser baixados após a finalização do job através da API userjobs api.
Baixar muitos dados?
Os parâmetroslimit e offset podem ser usados para dividir sua busca em partes. Alternativamente, use a opção save_job=T e depois baixe os dados com o parametro get_file=T da API userjobs.wildcards
Alguns parâmetros aceitam um asterisco como curinga, entãoapi/v0/taxons?name=Euterpe retornará táxons com nome exatamente como “Euterpe”, enquanto api/v0/taxons?name=Eut* retornará nomes começando com “Eut”.Parâmetros GET específicos
| Endpoint | Descrição | Parâmetros possíveis |
|---|---|---|
| / | Testa o acesso | nenhum |
| bibreferences | Obter referências bibliográficas | id, bibkey |
| biocollections | Lista de BioColeções registradas | id |
| datasets | Lista Conjuntos de Dados ou Baixa os arquivos de versões de conjuntos de dados | id, list_versions, file_name |
| individuals | Obter dados de Indivíduos (organisms) | id, location, location_root,taxon, taxon_root, tag,project, dataset |
| individual-locations | Obter localizações (ocorrências) de indivíduos | individual_id, location, location_root,taxon, taxon_root, dataset |
| languages | Lista de Idiomas | |
| measurements | Obter Medições | id, taxon,taxon_root,dataset,trait,individual,voucher,location,location_root |
| media | Obter Mídia Metadados | id, taxon,taxon_root,dataset,individual,voucher,location,location_root |
| locations | Obter localidades | root, id, parent_id,adm_level, name, limit, querytype, lat, long,project,dataset |
| persons | Lista de Pessoas | id, search, name, abbrev, email |
| projects | Lista de projects | id |
| taxons | Lista de Taxons | root, id, name,level, valid, external, project,dataset |
| traits | Lista Variáveis (traits) | id, name |
| vernacular | Lists vernaculars | id, individual,taxon,taxon_root |
| vouchers | Lista Vouchers | id, number, individual, location, collector, location_root,taxon, taxon_root,project, dataset |
| userjobs | Lista Jobs de Usuário | id, status |
Importar dados - POST
Atenção
- A importação de dados de arquivos por meio da interface da web requer a especificação dos parâmetros do verbo POST da API listados abaixo
- As importações em lote de Referências bibliográficas e Arquivos de Mídia só são possíveis por meio da interface no navegador.
| Endpoint | Descrição | Parâmetros POST |
|---|---|---|
| bibreferences | Importar Referências Bibliográficas | doi ou bibtex |
| biocollections | Importar BioColeções | name, acronym |
| individuals | Importar indivíduos | collector, tag, dataset, date, (location or latitude + longitude)**, altitude, location_notes, location_date_time, x, y, distance , angle , notes , taxon , identifier , identification_date , modifier, identification_notes , identification_based_on_biocollection, identification_based_on_biocollection_id , identification_individual |
| individual-locations | Importar Localidades de Indivíduos | individual, (location or latitude + longitude), altitude, location_notes, location_date_time, x, y, distance, angle |
| locations | Importar Localidades | name, adm_level, (geom or lat+long)** , parent, altitude, datum, x, y , startx, starty, notes, ismarine |
| measurements | Importar Medições | dataset, date, object_type, object_type, person, trait_id, value**, link_id, bibreference, notes, duplicated,location, parent_measurement |
| media | Importar Media | um arquivo zip com as imagens e uma tabela de atributos, ver detalhes aqui |
| persons | Importar Pessoas | full_name**, abbreviation, email, institution, biocollection |
| traits | Importar Variáveis | export_name, type, objects, name, description**, units, range_min, range_max, categories, wavenumber_min and wavenumber_max, value_length, link_type, bibreference, tags |
| taxons | Importar Taxons | name**, level, parent, bibreference, author, author_id or person, valid, mobot, ipni, mycobank, zoobank, gbif |
| vouchers | Importar Vouchers | individual, biocollection, biocollection_type, biocollection_number, number, collector, date, dataset, notes |
| vernacular | Importar Vernaculars | name, language,taxons,individuals,citations,parent |
** indica campos obrigatórios.
Atualizar dados - PUT
Atenção
Somente os endpoints listados abaixo podem ser atualizados usando a API e somente os campos PUT listados podem ser atualizados em cada endpoint. Os valores dos campos são os mesmos como explicados para a API POST, exceto que em todos os casos oid do registro a ser atualizado também deve ser fornecido.| Endpoint | Description | PUT Fields |
|---|---|---|
| individuals | Atualizar Indivíduos | (id or individual_id),collector, tag, dataset, date, notes , taxon , identifier , identification_date , modifier, identification_notes , identification_based_on_biocollection, identification_based_on_biocollection_id , identification_individual |
| individual-locations | Atualizar Localidades de Indivíduos | (id or individual_location_id), individual, (location or latitude + longitude), altitude, location_notes, location_date_time, x, y, distance, angle |
| locations | Atualizar Localidades | (id or location_id), name, adm_level, (geom or lat+long) , parent, altitude, datum, x, y , startx, starty, notes, ismarine |
| measurements | Atualizar Medições | (id or measurement_id), dataset, date, object_type, object_type, person, trait_id, value, link_id, bibreference, notes, duplicated,location, parent_measurement |
| persons | Atualizar Pessoas | (id or person_id),full_name, abbreviation, email, institution, biocollection |
| vouchers | Atualizar Vouchers | (id or voucher_id),individual, biocollection, biocollection_type, biocollection_number, number, collector, date, dataset, notes |
| media | Atualiza Media Metadados | (media_id ou media_uuid), collector,tags, date, title_en, title_pt, license, dataset, project, notes, (location ou longitude + latitude) |
Nomenclature Types
| Tipo Nomenclatural : código numérico | |
|---|---|
| NotType : 0 | Isosyntype : 8 |
| Type : 1 | Neotype : 9 |
| Holotype : 2 | Epitype : 10 |
| Isotype : 3 | Isoepitype : 11 |
| Paratype : 4 | Cultivartype : 12 |
| Lectotype : 5 | Clonotype : 13 |
| Isolectotype : 6 | Topotype : 14 |
| Syntype : 7 | Phototype : 15 |
Níveis taxonômicos (Ranks)
| Nível | Nível | Nível | Nível |
|---|---|---|---|
-100 clade | 60 cl., class | 120 fam., family | 210 section, sp., spec., species |
0 kingdom | 70 subcl., subclass | 130 subfam., subfamily | 220 subsp., subspecies |
10 subkingd. | 80 superord., superorder | 150 tr., tribe | 240 var., variety |
30 div., phyl., phylum, division | 90 ord., order | 180 gen., genus | 270 f., fo., form |
40 subdiv. | 100 subord. | 190 subg., subgenus, sect. |