Release NotesAnnouncementsVideosCommunityBlog
Guides

Set app link (URL) and CORS domain

United States
Canada
Europe
Latin America

The Clover integration for web applications uses the OAuth 2.0 protocol to secure API tokens for merchants. When setting up a web app, you must enter the app link or site URL, which merchants are redirected to after they install and launch an app from the Merchant Dashboard. You can also set a custom post-authorization landing page by including a redirect_uri parameter in the OAuth authorization request. Optionally, you can enter an Alternate Launch Path and CORS Domain values in the web app settings. See how to add web app settings.

All these configurations are set in the sandbox Developer Dashboard for testing and in the production Developer Dashboard to launch an approved app and publish it in the Clover App Market. See Use Clover developer environments for information on the Developer Dashboards.

Site URL (link)

The Site URL is the link where a merchant is redirected after they install your app and launch it from the Merchant Dashboard. Your authenticated merchants are sent to the Site URL after you redirect them to /oauth/authorize. Merchants can authenticate themselves by logging in or selecting their merchant account.

You can override the post-authorization landing page by providing a redirect_uri in your request to./oauth/authorize.

📘

NOTE

A redirect_uri passed to /oauth/authorize must be a subpath of the set Site URL.

For example, if you enter the site URL https://www.example.com/myapp, the redirect_uri of https://www.example.com/myapp/setup in your OAuth request is valid, but https://example.com/setup is invalid.

Cross-Origin Resource Sharing (CORS) (optional)

Clover implements Cross-Origin Resource Sharing (CORS), which lets you:

  1. Build pure HTML/JavaScript-based client applications without an app server to intermediate between your browser and the Clover server.
  2. Make requests from your client-side app to the Clover REST API using the XmlHttpRequests or AJAX requests.
  3. Connect a semi-integrated app to a Clover Flex, Mini, or Mobile using Cloud Pay Display.

🚧

IMPORTANT

Clover REST API does not support JSON with Padding (JSONP).

On the sandbox Developer Dashboard, enter your application domain, such as https://www.example.com or http://localhost:8000 for testing. You can use the OAuth access tokens from your application domain for cross-domain requests.

Troubleshoot CORS

If you experience difficulties in implementing CORS:

  • Verify that you have entered the Site URL and CORS Domain for your app in the sandbox Developer Dashboard.
  • Verify that you are using an OAuth token retrieved by following the correct OAuth flow. If you want an OAuth token instead of a code, set the response_type=token in the OAuth request.
  • Make sure that you are not using test API tokens (Setup > API Tokens) on the test Merchant Dashboard.

Alternate Launch Path

The Alternate Launch Path lets you configure an alternate link. If you have defined the alternate launch path link, your merchant is redirected to this link in your app after they install and launch the app from the Merchant Dashboard. This URL:

Updated 16 days ago