Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

1. Select Start > Search, and enter ODBC Data Sources in the Search box.
2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
3. Click the System DSN tab.
4. Select the system data source and click Configure.
5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Connecting to SAP Gateway

Set the following connection properties to access SAP Gateway tables.

• Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full url might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment url would just be: https://sapes5.sapdevcenter.com. Add any additional properties using the CustomUrlParams property.
• Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full url to the service is specified.
• Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full url is specified.
• CustomUrlParams: Set this to any required additional properties that need to be included with the HTTP request, for example sap-client=001&sap-language=EN.

Authenticating to SAP Gateway

SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts.

Basic

In basic authentication, you use your login credentials to connect. Set the following properties:

• AuthScheme: Set this to Basic.
• User: This is the username you use to log in to SAP Gateway.
• Password: This is the password you use to log in to SAP Gateway.

OAuth

You can connect without setting any connection properties for your user credentials.

When you connect, the driver opens the SAP Gateway OAuth endpoint in your default browser. Log in and grant permissions to the driver. The driver then completes the following OAuth process:

See Using OAuth Authentication for other OAuth authentication flows.

API Key

To connect using an ApiKey, set the APIKey property, and you are ready to connect.

In order to acquire an APIKey, open the Developer Portal and select the Product or Service for which you have published the API. Then, click on Subscribe > Create a new Application. After filling the necessary information and creating the application, the Application Key is going to be displayed. You can copy this value into the APIKey connection property.

You may set the AuthScheme to Token to enforce the Token based Authentication scheme.