Guides

guides-icon

Publishing an App for Ecommerce

This guide describes the necessary steps for listing and publishing an Ecommerce application on the ADP Marketplace.

Step 1: Access Your Marketplace Account

Before you begin, make sure that you have set up:


To access your Marketplace Partner account:

  1. On the ADP Marketplace website, click SIGN IN.

    pubAppEcomm-Step1

  2. Enter your username and password and click SIGN IN.
  3. On the User Consent page, click CONFIRM to allow access to your contact information and unique identifier.

Step 2: Add an App Listing to the ADP Marketplace

  1. Sign in to your Partner account on the ADP Marketplace website if you are not already done so.
  2. On the Marketplace main page, select Developer > Products. If you have apps in the Marketplace, click Add Products. The Create New Product form appears.

    pubAppEcomm-Step1

  3. On the Create New Product page, enter the following information.
  4. In the Product Name field, enter a name for your app.
  5. In the Integration Type field, select Full Integration.
  6. In the Usage Model field, select Multiple Users.
  7. In the Revenue Model field, select the option you want to use.
  8. Check “I agree to the distribution terms and conditions.” and then click Create Product.

    Note: Your app listing is created as a draft on the ADP Marketplace. It has not been published yet.

Step 3: Create a Marketing Profile

To configure the marketing profile for your app, follow these instructions:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.

    pubAppEcomm-Step4.png

  3. On the left side of the dashboard, under Profile & Branding, select and edit each of the items listed. Refer to the PDF guide Creating Effective Marketplace Listings for more information.

Step 4: Create Editions and Pricing

To configure editions and pricing for your app, use the following instructions:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.

    pubAppEcomm-Step5.png

  3. On the left side of the dashboard, under Editions and Pricing, select and edit each of the items listed. Refer to the PDF guide Creating Effective Marketplace Listings for more information.

Step 5: Configure Endpoints

To configure endpoint URLs for your app, follow these instructions:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.

    pubAppEcomm-Step3.png

  3. On the left side of the dashboard, under Integration, select Edit Integration.
  4. Configure each integration setting URL with the options described in the table. These URLs must be accessible through the internet and contain the {eventUrl} placeholder. This placeholder will be replaced by the URL of the order event at runtime. For example: https://example.com/appdirect/notify.php?url={eventUrl}

    Note: Data Connector applications support the Subscription Create Notification and Subscription Cancel Notification events only.




  5. Subscriptions Options
    Subscription Create Notification URL
    • ADP will call this URL when users purchase new subscriptions.
    • This URL can either be non-interactive (default and recommended behavior) or interactive.
    • This URL must contain the {eventUrl} placeholder which will be replaced by the URL of the order event at runtime.
    • Optional – To configure additional product settings at checkout, select “Additional product settings required during checkout.”The Additional Settings form will also be displayed.
    Subscription Change Notification URL
    • ADP will call this URL when users upgrade/downgrade subscriptions.
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder which will be replaced by the URL of the order event at runtime.
    • Optional – To configure additional product settings at checkout, select “Additional product settings required during checkout.”
      The Additional Settings form will also be displayed.
    Subscription Cancel Notification URL
    • ADP will call this URL when users cancel subscriptions
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder, which will be replaced by the URL of the order event at runtime.
    Subscription Status Notification URL
    • ADP will call this URL when a subscription status changes.
    • For example, when a subscription becomes suspended after a free trial expires or gets automatically cancelled sometime after an invoice is overdue.
    • This URL can only be non-interactive.
    • This URL must contain the {eventUrl} placeholder, which will be replaced by the URL of the order event at runtime.


    pubAppEcomm-Step3b.png

  6. To verify that your endpoints are valid, select Integration Report in the dashboard menu.
    Click the Test Integration button and verify that the status button for each event is green. Address any issues and repeat as needed.

    pubAppEcomm-Step3c.png

Step 6: Configure Authentication

To configure authentication for your app, follow these instructions:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.

    pubAppEcomm-EditAuthentication.png

  3. On the left side of the dashboard, under Integration, select Edit Authentication.
  4. Enter a Login URL to define where the logged in user is directed upon clicking your application tile under MY APPS within the ADP Marketplace. This may be an endpoint to initiate SSO for your end user consumer application, or an HTML landing page that provides next steps for your data connector.

Step 7: Submit Publishing Request

After you have configured your app listing, you can submit your app for ADP review and approval using these steps:

  1. Sign in to your Partner account on the ADP Marketplace website if you have not already done so.
  2. On the Marketplace main page, select Developer > Products and then click Edit for your product.
  3. On the left side of the dashboard, select Publish.

    pubAppEcomm-Step6