Skip to content

Commit 4ec3b8d

Browse files
[Apple Shared Secret] Added SK1 and SK2 context (#939)
* added apple shared secret context * update as per PR comments * update 2 * removed table * one more tweak
1 parent 46574b8 commit 4ec3b8d

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

docs/service-credentials/itunesconnect-app-specific-shared-secret.mdx

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,37 @@ excerpt: Getting your App Store Connect App-Specific Shared Secret
66
hidden: false
77
---
88

9-
The App-Specific Shared Secret allows RevenueCat to connect with Apple on your behalf.
9+
The App-Specific Shared Secret is a unique authentication key that allows RevenueCat to securely communicate with Apple's servers on your behalf. This secret is **mandatory for receipt validation** when using **StoreKit 1**.
1010

11-
## Setup
11+
:::warning
12+
StoreKit 1 is now deprecated by Apple. New apps are recommended to use **StoreKit 2**. See our [migration guide](/sdk-guides/ios-native-4x-to-5x-migration) for details.
13+
:::
14+
15+
## StoreKit Version Requirements
16+
17+
The App-Specific Shared Secret is required for **StoreKit 1** implementations. For **StoreKit 2** apps, you'll need an [In-App Purchase Key](/service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration) instead.
18+
19+
### StoreKit 2 (Recommended)
20+
21+
- **Required**: [In-App Purchase Key](/service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration) (comprising Issuer ID, Key ID, and Private Key)
22+
- **Use case**: Modern apps using iOS 15+ with RevenueCat SDK v5.0+
23+
- **Purpose**: Server-to-server communication with Apple's App Store Server API for validating transactions, managing subscriptions, and accessing detailed purchase information
24+
25+
:::info
26+
The In-App Purchase Key is required for all in-app purchases (including subscriptions) when using StoreKit 2 and RevenueCat v5.0+. This key enables RevenueCat to securely access Apple's APIs and ensure accurate validation and reporting.
27+
:::
28+
29+
### StoreKit 1
30+
31+
- **Required**: App-Specific Shared Secret
32+
- **Use case**: Legacy apps, apps targeting iOS 15 or earlier
33+
- **Purpose**: Server-side receipt validation and subscription management for the traditional receipt-based flow
34+
35+
## Setup (StoreKit 1 Only)
36+
37+
:::warning
38+
This setup is only required for StoreKit 1 implementations. If you're using **StoreKit 2**, see [In-App Purchase Key Configuration](/service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration) instead.
39+
:::
1240

1341
### 1. Generating an App-Specific Shared Secret
1442

@@ -28,3 +56,20 @@ The App-Specific Shared Secret allows RevenueCat to connect with Apple on your b
2856
Enter the secret in your iOS app settings in the RevenueCat dashboard:
2957

3058
![Shared secret input](/docs_images/credentials/apple/shared-secret-input.png)
59+
60+
## Troubleshooting
61+
62+
### Receipt Validation Issues
63+
64+
If you're experiencing server-side receipt validation failures, ensure you've configured the appropriate credentials for your StoreKit version:
65+
66+
- **StoreKit 1**: App-Specific Shared Secret (this page)
67+
- **StoreKit 2**: [In-App Purchase Key](/service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration)
68+
69+
### Migration Context
70+
71+
If you're migrating from StoreKit 1 to StoreKit 2, you'll need to:
72+
73+
1. Update to [RevenueCat SDK v5.0+](/sdk-guides/ios-native-4x-to-5x-migration)
74+
2. Configure an [In-App Purchase Key](/service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration)
75+
3. Remove the App-Specific Shared Secret configuration

0 commit comments

Comments
 (0)