### Obtaining Your Datamesh Token Source: https://docs.oceanum.io/docs/datamesh/token/index Instructions on how to retrieve your Datamesh token from your account settings. ```APIDOC ## Obtaining Your Datamesh Token ### Description To obtain your Datamesh token, navigate to your account settings page. Your organization details and Datamesh token will be displayed there. ### Method Web Interface Navigation ### Endpoint `/account/settings` (Hypothetical URL) ### Parameters No API parameters required. Access is through the user interface. ### Request Example Access your account settings via your web browser. ### Response Your Datamesh token will be displayed on the account settings page. ``` -------------------------------- ### Obtaining Your Datamesh Token Source: https://docs.oceanum.io/docs/datamesh/token Instructions on how to retrieve your Datamesh token from your account settings. ```APIDOC ## Obtaining Your Datamesh Token ### Description This section provides instructions on how to find and retrieve your Datamesh token. ### Method N/A (Informational) ### Endpoint N/A (Informational) ### Parameters N/A ### Request Example N/A ### Response #### Success Response (N/A) Your account settings page will display your organization and Datamesh token. #### Response Example N/A ### Steps to Obtain Token 1. Navigate to 'Your account settings'. 2. Your organization and Datamesh token will be displayed on this page. ``` -------------------------------- ### OceanQL API Source: https://docs.oceanum.io/docs/Datamesh/apis Query for subsets or sections of datasources, including direct download. Used by the Datamesh UI and integration libraries. ```APIDOC ## OceanQL API ### Description The OceanQL endpoint allows querying for subsets or sections of datasources, including direct download capabilities. It is utilized by the Datamesh UI and integration libraries. ### Method POST ### Endpoint `https://gateway.datamesh.oceanum.io/oceanql` ### Parameters #### Request Body - **query** (string) - Required - The OceanQL query string. ### Request Example ```json { "query": "SELECT * FROM my_datasource WHERE time > '2023-01-01T00:00:00Z'" } ``` ### Response #### Success Response (200) - **data** (object) - The queried subset or section of the datasource. #### Response Example (Response format depends on the OceanQL query and the nature of the data) ``` -------------------------------- ### WFS3.0 API Source: https://docs.oceanum.io/docs/Datamesh/apis Access vector datasources through a WFS3.0 service compliant with the OGC Features API specification. ```APIDOC ## WFS3.0 API ### Description This API provides access to all vector datasources and is fully compliant with the OGC Features API specification. ### Method GET ### Endpoint `https://gateway.datamesh.oceanum.io/features` ### Parameters #### Query Parameters (Refer to OGC Features API specification for available parameters) ### Request Example (No specific request body for this endpoint, uses standard WFS3.0 requests) ### Response #### Success Response (200) - **Features** (object) - GeoJSON FeatureCollection containing vector data. #### Response Example ```json { "type": "FeatureCollection", "features": [ { "type": "Feature", "id": "feature-1", "geometry": { "type": "Point", "coordinates": [102.0, 0.5] }, "properties": { "name": "Example Feature" } } ] } ``` ``` -------------------------------- ### Datamesh Token Authentication Header Source: https://docs.oceanum.io/docs/Datamesh/token/index All datasource access through the APIs is authorized with a token that must be included in the HTTP request header. ```APIDOC ## Datamesh Token Authentication ### Description This section details how to authenticate API requests using the Datamesh Token. The token must be included in the `X-DATAMESH-TOKEN` HTTP request header for all datasource access. ### Method All HTTP methods (GET, POST, PUT, DELETE, etc.) require this header for authentication. ### Endpoint All API endpoints that access datasources. ### Parameters #### Request Headers - **X-DATAMESH-TOKEN** (string) - Required - Your Datamesh token for authentication. ### Request Example ```bash GET /api/datasources/your-datasource-id Host: api.oceanum.io X-DATAMESH-TOKEN: Accept: application/json ``` ### Obtaining Your Token To obtain your Datamesh token, navigate to your account settings within the platform. Your organization and Datamesh token will be displayed there. ``` -------------------------------- ### Zarr API Source: https://docs.oceanum.io/docs/Datamesh/apis Access datasets using the Zarr specification, providing lazy chunked access to large datasets. ```APIDOC ## Zarr API ### Description This endpoint allows access to all datasets using the Zarr specification, which facilitates lazy, chunked access to large datasets. ### Method GET ### Endpoint `https://gateway.datamesh.oceanum.io/zarr/` ### Parameters #### Path Parameters - **datasource_id** (string) - Required - The unique identifier of the datasource. ### Request Example (This is typically accessed via Zarr libraries which handle the underlying HTTP requests.) ### Response #### Success Response (200) - **Zarr Store** (object) - A Zarr-compatible object representing the dataset. #### Response Example (Responses are typically Zarr store objects that are read by Zarr libraries.) ``` -------------------------------- ### Zarr Source: https://docs.oceanum.io/docs/Datamesh/apis/index Access datasets using the Zarr specification, which provides lazy chunked access to large datasets. The endpoint requires a datasource ID. ```APIDOC ## Zarr ### Description This endpoint provides access to datasets using the Zarr specification, enabling lazy, chunked access to large datasets. ### Method GET ### Endpoint `https://gateway.datamesh.oceanum.io/zarr/` ### Parameters #### Path Parameters - **datasource_id** (string) - Required - The unique identifier for the datasource. ### Request Example `GET https://gateway.datamesh.oceanum.io/zarr/my_dataset_id/` ### Response #### Success Response (200) - **Zarr Store**: Access to the Zarr array store, allowing for chunked and lazy data retrieval. #### Response Example (This endpoint typically returns a Zarr store that can be accessed by compatible libraries. Direct response examples are complex and depend on the Zarr library used.) ``` -------------------------------- ### Zarr Access Source: https://docs.oceanum.io/docs/datamesh/apis/index Access datasets using the Zarr specification, providing lazy chunked access to large datasets. The Zarr endpoint is at https://gateway.datamesh.oceanum.io/zarr/. ```APIDOC ## Zarr Access ### Description Provides access to datasets using the Zarr specification, enabling lazy chunked access to large datasets. Integration libraries are recommended for ease of use. ### Method GET ### Endpoint `https://gateway.datamesh.oceanum.io/zarr/` ### Parameters #### Path Parameters - **datasource_id** (string) - Required - The unique identifier for the dataset. ### Request Example (No specific request example provided, refer to Zarr specification and integration libraries) ### Response #### Success Response (200) (Returns Zarr-formatted data. Refer to Zarr specification.) #### Response Example (No specific response example provided, refer to Zarr specification) ``` -------------------------------- ### Datamesh Token Authentication Header Source: https://docs.oceanum.io/docs/datamesh/token All API requests to access datasources must include the Datamesh token in the HTTP request header. ```APIDOC ## Datamesh Token Authentication ### Description This section details how to include the Datamesh token in your API requests for datasource access. ### Method All HTTP requests requiring authentication. ### Endpoint N/A (Applies to all endpoints requiring authentication) ### Parameters #### Request Headers - **X-DATAMESH-TOKEN** (string) - Required - Your Datamesh token for authorization. ### Request Example ```http GET /api/datasources HTTP/1.1 Host: api.oceanum.io X-DATAMESH-TOKEN: ``` ### Response #### Success Response (200) - **N/A** (N/A) - Successful authentication allows access to the requested resource. #### Response Example ```json { "message": "Access granted" } ``` ``` -------------------------------- ### EDR API Source: https://docs.oceanum.io/docs/Datamesh/apis Access gridded datasources through the OGC Environmental Data Retrieval (EDR) service. Note: This API is partially implemented. ```APIDOC ## EDR API ### Description This API exposes gridded datasources using the OGC Environmental Data Retrieval service. It is compliant with the OGC EDR API specification but is only partially implemented. ### Method GET ### Endpoint `https://gateway.datamesh.oceanum.io/edr` ### Parameters #### Query Parameters (Refer to OGC EDR API specification for available parameters) ### Request Example (No specific request body for this endpoint, uses standard EDR requests) ### Response #### Success Response (200) - **Data** (object) - Environmental data based on the EDR specification. #### Response Example (Response format depends on the specific EDR query and data type) ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.