Serviço de dados - boias Datawell Waverider

1. Introdução

Esta página tem como objetivo descrever o processo de acesso aos dados da Marine Spatial Data Infrastructure (MSDI) Hidrográfico+, através de uma Application Programming Interface (API).

O Hidrográfico+ constitui o ponto de acesso único, na web, aos dados do Instituto Hidrográfico (IH). Neste sentido, foram desenvolvidos serviços web que suportam dados estáticos e dinâmicos. Seguindo os princípios das MSDI, privilegiou-se a utilização de formatos normalizados do Open Geospatial Consortium (OGC) e, em casos específicos, foram desenvolvidos serviços REST que devolvem os dados em formato JSON.

2. Boias Datawell Waverider

2.1. API

O acesso aos dados das boias Datawell Waverider, em near real time (NRT), é efetuado através de uma API.

Devido à natureza e âmbito deste serviço (acesso concorrente a dados NRT, por múltiplos utilizadores), a dimensão da série temporal encontra-se restringida a 15 dias de dados.

2.2. Acesso aos dados

2.2.1. Lista das boias

A lista das boias disponíveis pode ser obtida através dos serviços de dados descritos na respetiva ficha de metadados:

https://metadata.hidrografico.pt/geonetwork/srv/por/catalog.search#/metadata/0205ed82-a085-4432-98f5-ff0326c4d4de

Estes dados podem ser obtidos diretamente no formato GeoJSON, através do seguinte URL:

https://webgeo4.hidrografico.pt/geoserver/oceanography/ows?service=WFS&version=2.0.0&request=GetFeature&typeName=oceanography%3Abuoys_datawell&outputFormat=application%2Fjson

O serviço devolve um objeto do tipo FeatureCollection com os pares chave-valor descritos na seguinte tabela:

Chave	Valor	Formato
id_est	Código único de identificação da boia	int4
id_fund	Código único de identificação do fundeamento	int4
nome	Designação da boia	text
area	Designação da localização da boia	text
wmo_id	Código único de identificação da boia na World Meterorological Organization (WMO)	numeric
aton_id	Código único de identificação da boia na Lista de Luzes (PN35)	text
depth	Profundidade, em metros, na posição de fundeamento da boia	numeric
status	Indicador do estado da boia (ativa ou inativa)	text
nrtd	Indicador da disponibilidade de dados em NRT	text
last_pos	Data e hora, em UTC, dos últimos dados de posicionamento	timestampz
last_sea	Data e hora, em UTC, dos últimos dados oceanográficos	timestampz
entity	Identificação da entidade responsável pelo equipamento	text

A figura seguinte exemplifica uma chamada a este serviço através do browser Firefox.

2.2.2. Parâmetros de agitação marítima

As séries temporais dos parâmetros de agitação marítima são obtidos através do seguinte URL:

https://supportserver1.hidrografico.pt/geodata/buoys/getDatawellData?

A utilização deste serviço requer a autenticação do utilizador através de uma API key, conforme descrito na secção 2.3.

Para este serviço encontram-se definidos os seguintes argumentos:

Argumento	Formato	Exemplo
startDate	YYYY-MM-DDTHH:MM:SS.SSSZ	2023-08-14T08:00:00.000Z
endDate	YYYY-MM-DDTHH:MM:SS.SSSZ	2023-08-16T08:00:00.000Z
stationId	Número inteiro correspondente ao código de identificação da boia	19

O serviço devolve os pares chave-valor descritos na seguinte tabela:

Chave	Valor	Formato
id	Código único de identificação da observação	Número inteiro
date	Data e hora (fuso UTC+0)	YYYY-MM-DDTHH:MM:SS.SSS+0000
hm0	Altura significativa (método espectral) (em m)	Número decimal
qc_hm0	Indicador de qualidade do parâmetro anterior	Número inteiro
t02	Período médio (método espectral) (em s)	Número decimal
qc_t02	Indicador de qualidade do parâmetro anterior	Número inteiro
tp	Período de pico (método espectral) (em s)	Número decimal
qc_tp	Indicador de qualidade do parâmetro anterior	Número inteiro
thtp	Direção média no período de pico (método espectral) (em º, sentido horário desde o norte)	Número decimal (0 a 360)
qc_thtp		Número inteiro
sprtp	Dispersão no período de pico (método espectral) (em º, sentido horário desde o norte)	Número decimal (0 a 360)
qc_sprtp	Indicador de qualidade do parâmetro anterior	Número inteiro
hs	Altura significativa (zero ascendente, método direto) (em m)	Número decimal
qc_hs	Indicador de qualidade do parâmetro anterior	Número inteiro
tz	Período médio (método direto) (em s)	Número decimal
qc_tz	Indicador de qualidade do parâmetro anterior	Número inteiro
hmax	Altura máxima (em m)	Número decimal
qc_hmax	Indicador de qualidade do parâmetro anterior	Número inteiro
tmax	Período máximo (em s)	Número decimal
qc_tmax	Indicador de qualidade do parâmetro anterior	Número inteiro
thmax	Período associado à altura máxima (em s)	Número decimal
qc_thmax	Indicador de qualidade do parâmetro anterior	Número inteiro
h10	Não aplicável	Número decimal
qc_h10	Indicador de qualidade do parâmetro anterior	Número inteiro
hmed	Não aplicável	Número decimal
qc_hmed	Indicador de qualidade do parâmetro anterior	Número inteiro
thlf	Não aplicável	Número decimal
qc_thlf	Indicador de qualidade do parâmetro anterior	Número inteiro
thhf	Não aplicável	Número decimal
qc_thhf	Indicador de qualidade do parâmetro anterior	Número inteiro
temp	Não aplicável	Número decimal
qc_temp	Indicador de qualidade do parâmetro anterior	Número inteiro

A figura seguinte exemplifica uma chamada a este serviço através da plataforma Postman.

2.2.3. Temperatura da superfície do mar

As séries temporais da temperatura da superfície do mar são obtidas através do seguinte URL:

https://supportserver1.hidrografico.pt/geodata/buoys/getDatawellTemp?

A utilização deste serviço requer a autenticação do utilizador através de uma API key, conforme descrito na secção 2.3.

Para este serviço encontram-se definidos os seguintes argumentos:

Argumento	Formato	Exemplo
startDate	YYYY-MM-DDTHH:MM:SS.SSSZ	2023-09-01T08:00:00.000Z
endDate	YYYY-MM-DDTHH:MM:SS.SSSZ	2023-09-15T08:00:00.000Z
stationId	Número inteiro correspondente ao código de identificação da boia	19
qc	Código de controlo de qualidade dos dados.	1

O serviço devolve os pares chave-valor descritos na seguinte tabela:

Chave	Valor	Formato
id	Código único de identificação da observação	Número inteiro
date	Data e hora (fuso UTC+0)	YYYY-MM-DDTHH:MM:SS.SSS+0000
temp	Temperatura da água do mar (em ºC)	Número decimal
qc_temp	Indicador de qualidade do parâmetro anterior	Número inteiro

A figura seguinte exemplifica uma chamada a este serviço através da plataforma Postman.

2.3. Autenticação dos utilizadores

O acesso a determinados dados requer a autenticação do utilizador através de uma API key. Esta chave é identificada através da expressão X-API-KEY.

A API key é gratuita e pode ser obtida mediante pedido específico para o e-mail cedencia.dados@hidrografico.pt.

Esta autenticação tem como objetivo exclusivo a produção de métricas que permitam analisar o interesse dos dados para os utilizadores, a fim de calcular indicadores de qualidade do serviço e melhorar a gestão e futuro desenvolvimento do Hidrográfico+. Estas métricas resultam de processos de análise agregados, não particularizando qualquer informação dos originadores dos pedidos.