• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsWooCommerce

    WooCommerce

    The WooCommerce connector is a Palantir-provided driver for WooCommerce.

    To create a new WooCommerce source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for WooCommerce-specific configuration and networking. For the complete property reference, see the official WooCommerce driver documentation ↗.

    Configuration

    The properties below are mandatory or recommended.

    PropertyRequired?DescriptionDefault
    AuthScheme ↗MandatoryWhether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.Basic
    URL ↗MandatoryThe URL of the WooCommerce instance.https://{serverAddress}/woocommerce/
    ConsumerKey ↗RecommendedThe consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.—
    ConsumerSecret ↗RecommendedThe consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.—
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    OAuthClientId ↗RecommendedSpecifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.—
    OAuthClientSecret ↗RecommendedSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server.—

    Networking

    The table below lists the domains that the source needs to be able to access in order to successfully run.

    For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.

    DomainRequired
    <URL>Always. URL connection property (in format URL='http://localhost/woocommerce/')