Passing the connection URL

After setting the CLASSPATH, the required connection information needs to be passed in the form of a connection URL. The form of the connection URL differs depending on whether you are using a REST file

For sessions using a REST file (sessions with multiple endpoints, PUSH requests, or paging):

jdbc:datadirect:autorest:servername;AuthenticationMethod=UrlParameter;
AuthParam=auth_param;Config=rest_file_path;SecurityToken=token;
User=user_name;Password=password;[property=value[;...]];

jdbc:datadirect:autorest:AuthenticationMethod=UrlParameter;
AuthParam=auth_param;Sample=sample_path;SecurityToken=token;
User=user_name;Password=password;[property=value[;...]];

(optional) specifies the host name portion of the HTTP endpoint to which you send requests. Specify this value if you want to define endpoints without the web server address in the REST config file.

Specifies the name of the URL parameter used to pass the security token. For example, apikey or key.

specifies the name and location of the input REST file that contains a list of endpoints to sample, PUSH request definitions, and configuration information. See "Creating an Input REST file" for details.

specifies the security token required to make a connection to your REST API endpoint.

specifies the user name used to access your endpoint.

specifies the password used to access your endpoint.

specifies connection property settings. Multiple properties are separated by a semi-colon.

specifies the endpoint the sample when not using a REST file.

The following examples demonstrate a URLs for sessions using URL parameter authentication:

Connection conn = DriverManager.getConnection
("jdbc:datadirect:autorest:https://api.mysite.com/;
AuthenticationMethod=UrlParameter;AuthParam=apikey;
Config=C:/path/to/mysite.rest;SecurityToken=XaBARTsLZReM;
User=jsmith;Password=secret;");

Connection conn = DriverManager.getConnection
("jdbc:datadirect:autorest:AuthenticationMethod=UrlParameter;AuthParam=apikey;
Sample=https://api.mysite.com/countries/get/all;SecurityToken=XaBARTsLZReM;
User=jsmith;Password=secret;");