connect: Connect to a openEO service

View source: R/user.R

connectR Documentation

Connect to a openEO service

Description

Connects to openEO service. If the back-end provides a well-known endpoint that allows redirecting to specific versions you should provide the version parameter.

Usage

connect(host, version = NULL, exchange_token = "access_token", ...)

Arguments

host

URL pointing to the openEO server service host

version

the openEO API version number as string (optional), see also api_versions

exchange_token

'access_token' or 'id_token' defines in the OIDC case the bearer token use

...

parameters that are passed on to login

Details

You can explore several already available openEO web services by using the openEO hub (https://hub.openeo.org/). There you have an overview about their status and connection details like the URL and supported features. You can explore the service for free through the access to publicly available metadata of data collections as well as the offered processing functions. For any computation and the creation of web services, you need to register the openEO partner of your choice. There you will get further information on credentials and the log in procedure.

The ... parameter allows you to pass on arguments directly for login. If they are omitted the client will only connect to the back-end, but does not do authentication. The user must do that manually afterwards. Based on the provided login parameters user / password or OIDC provider the appropriate login procedure for basic authentication or OIDC authentication will be chosen.

The parameter version is not required. If the service offers a well-known document of the service the client will choose an appropriate version (default the most recent production ready version).

When calling this function the OpenEOClient is also stored in a variable in the package which marks the latest service that was connected to.

See Also

active_connection

Examples

## Not run: 
# The following examples show different configuration settings and point 
# to imaginary URLs. Please obtain a valid URL via the openEO hub and 
# register with one of the provider if required.

# connect to a host of the latest version and without authentication
con = connect(host='http://example.openeo.org')

# connect to a host by direct URL and basic log in
con = connect(host='http://example.openeo.org/v1.0',
              user='user',
             password='password')

# connect to a host with open id connect authentication
con = connect(host='http://example.openeo.org')

# connect and login with a named and valid oidc provider
con = connect(host='http://example.openeo.org',
              provider='your_named_provider')

## End(Not run)


openeo documentation built on June 24, 2022, 9:06 a.m.