open(url:)

Presents a continuation sheet that enables people to choose whether your app shows the indicated URL link for external purchases.

Declaration

static func open(url: URL) async throws

Parameters

url:
An eligible external purchase link that you select from the Eligibleurls array.

Mentioned in

Receiving and decoding external purchase tokens

Discussion

Call this method if your app configures the SKExternalPurchaseMultiLink property list key to attempt to open the eligible external purchase link, url. Call this asynchronous method as shown below:

if let eligibleURLs = await ExternalPurchaseLink.eligibleURLs {
    let url = chooseTheUrl(eligibleURLs) // Supply a function to choose one of the eligible URLs.
    try await ExternalPurchaseLink.open(url: url)
  }

To use this method, follow these steps:

Check the eligibleURLs array. If the array contains one or more links, your app can display the user-interface controls to enable deliberate user interaction before offering an external purchase link.
Select one of the eligible links.
In response to deliberate user interaction, such as tapping a button, call open(url:) with the link you select.

The system displays the continuation sheet that enables the user to choose whether to continue to view the external purchase link. This asynchronous method returns before the system presents the continuation sheet, and can throw an error.

If the person chooses to continue, this method opens the link that you provide in the url parameter, and appends an external purchase token and the app’s bundleID to the URL. For example, StoreKit opens the following link on the default browser if your destination URL is https://site.example.com:

https://site.example.com?externalPurchaseToken=ewoJImFwcEFwcGxlSWQiOjEyMzQ1Njc4OTAsCgkiYnVuZGxlSWQiOiJjb20uZXhhbXBsZSIsCgkidG9rZW5DcmVhdGlvbkRhdGUiOjE3MDYxNjk2MDAwMDAsCgkiZXh0ZXJuYWxQdXJjaGFzZUlkIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgp9&bundleId=com.example

Handle errors

This method throws a StoreKitError if any of the following are true:

Your app doesn’t have the com.apple.developer.storekit.external-purchase-link entitlement.
You haven’t configured external purchase links for the current App Store storefront in the SKExternalPurchaseMultiLink property list key.
The current App Store storefront doesn’t support external purchases.
The person is ineligible to make external purchases.
A network or system error occurs.

For more information about App Store storefronts, see Storefront.