Marketo
Both the REST and SOAP APIs are supported and can be chosen using the Schema property.
1 Connecting to the Marketo REST API
Before you can connect to the Marketo REST API, you will need to create a custom service.
1.1 Creating a Custom Service
To create a custom service, follow the procedure below:
Navigate to the admin area of your Marketo application.
Click Users & Roles in the Security section.
Select the Roles tab and click New Role to create a new Role.
Enter a Role Name and select the permissions for the Role. The Access API permissions are specific to the REST API.
Now that an API Role is created, select the Users tab and click Invite New User.
Enter the new user information and select the role that was just created with API access. The API Only option can be selected to denote the user as an API Only user.
Now that a new user has been created, a new service will need to be created. Click the LaunchPoint option (Admin -> Integration -> LaunchPoint).
Click New Service.
Select the Custom service type and enter a display name and description.
Select the user you created.
1.2 Obtaining OAuth Credentials
To obtain the OAuthClientId and OAuthClientSecret, navigate to the LaunchPoint option on the Admin area.
Click the View Details link for the desired service. A window containing the authentication credentials is displayed.
1.3 Authenticating to the REST API
Once you have created a custom service and obtained your OAuth credentials, set the following to connect to data:
Schema: Set this to REST.
OAuthClientId: The OAuth Client ID associated with your custom service.
OAuthClientSecret: The OAuth Client Secret associated with your custom service.
RESTEndpoint: The URL of the REST Web service endpoint. This can be found on your Marketo Admin area on the Integration -> Web Services option in the REST API section.
The Identity Endpoint will not be needed.
2 Connecting to the Marketo SOAP API
To connect to the SOAP API, you will need to provide valid Marketo credentials. Specify the following to connect to data:
Schema: Set this to SOAP.
UserId: The client access ID is found within your Marketo admin SOAP API panel under Integration.
EncryptionKey: The Marketo SOAP API Encryption Key. This key is generated on the Admin page of the Marketo website.
SOAPEndpoint: The URL of the SOAP Web service endpoint, provided by Marketo on the Admin page of the Marketo website.
The following are the connection properties for Marketo. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Property
|
Description
|
Caching | |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
CacheProvider | The name of the provider to be used to cache data. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Offline | Use offline mode to get the data from the cache instead of the live source. |
Firewall | |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
Logging | |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Misc | |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectionString | *** |
JobPollingInterval | Specifies the polling interval (in seconds) when checking the status of a bulk API job. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The number of results to return per page from Marketo. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Readonly | You can use this property to enforce read-only access to Marketo from the provider. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseBulkAPI | Specifies whether to use the Marketo Bulk API. |
UseConnectionPooling | This property enables connection pooling. |
OAuth | |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
Proxy | |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
REST | |
RESTEndpoint | The Marketo REST API Endpoint. |
Schema | |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Schema | The type of schema to use. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
SOAP | |
EncryptionKey | The Marketo SOAP API Encryption Key. |
SOAPEndpoint | The Marketo SOAP API Endpoint. |
UserId | The Marketo SOAP API User Id. |
Last updated