-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[signature] [ios] Reflect integration methods & SDK v5 influence
- Loading branch information
Showing
2 changed files
with
100 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,18 +43,59 @@ To update the Adjust Signature library, replace the existing Signature library w | |
| - They're no longer contributing to your install reporting. | ||
| - You've fully released a new version of your app (across all app platforms and stores). | ||
|
|
||
| ## Integrate the signature library (SDK v4 only) {#integrate-the-signature-library} | ||
| ## Integrate the signature library {#integrate-the-signature-library} | ||
|
|
||
| <Callout type="note"> | ||
|
|
||
| Adjust SDK v5 supports SDK signature verification natively. If you previously integrated the SDK signature library, you should uninstall it and remove all related code. | ||
| This step can be skipped if using SDK v5, as the Signature library is bundled by default for the majority of cases. Proceed only if prompted by the SDK or if a specific version is required. | ||
|
|
||
| </Callout> | ||
|
|
||
| Follow these steps to integrate the Signature library in your iOS project. | ||
| <Tabs> | ||
| <Tab title="Cocoapods" sync="cocoapods"> | ||
|
|
||
| 1. Download the [`AdjustSigSdk-iOS-tvOS-Dynamic.xcframework.zip` archive from GitHub](https://github.com/adjust/adjust_signature_sdk/releases/latest). | ||
| 2. Unzip the archive and copy the `AdjustSigSdk.xcframework` into your project’s directory. | ||
| The Signature libraries are released on [GitHub](https://github.com/adjust/adjust_signature_sdk/releases/) and are propagated to Cocoapods from version `3.20.1` onwards. To add the Signature library to your project, append the following to your `Podfile` (change the version with the [latest available](https://github.com/adjust/adjust_signature_sdk/releases/latest)): | ||
|
|
||
| ```ruby | ||
| pod 'AdjustSignature', '~> x.x.x' | ||
| ``` | ||
|
|
||
| Alternatively, Beta releases are available from version `3.24.1` onwards. To add the Signature library to your project, append the following to your `Podfile` (change the version with the [latest available](https://github.com/adjust/adjust_signature_sdk/releases)): | ||
|
|
||
| ```ruby | ||
| pod 'AdjustSignature', 'x.x.x-beta' | ||
| ``` | ||
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| <Tab title="Swift Package Manager" sync="swift-package-manager"> | ||
|
|
||
| SPM support is available from version `3.20.1` onwards. To add the Signature library, you need to add it to your Xcode project: | ||
|
|
||
| 1. Select **File —> Swift Packages —> Add Package Dependency** | ||
| 2. In the box that appears, enter the Signature’s GitHub address: https://github.com/adjust/adjust_signature_sdk | ||
| 3. Enter the version of the library you want to use in the **Version** field. Check the [releases page](https://github.com/adjust/adjust_signature_sdk/releases/latest) for the latest version. | ||
|
|
||
| Alternatively, SPM support is available for Beta releases from version `3.24.1` onwards. To add the Signature library, you need to add it to your Xcode project: | ||
|
|
||
| 1. Select **File —> Swift Packages —> Add Package Dependency** | ||
| 2. In the box that appears, enter the Signature’s GitHub address: https://github.com/adjust/adjust_signature_sdk | ||
| 3. Enter `release/vx.xx` in the **Branch** field. Replace `x.xx` with the latest major and minor version from the [releases page](https://github.com/adjust/adjust_signature_sdk/releases) e.g. `release/v3.24`. | ||
|
|
||
| <Callout type="note"> | ||
|
|
||
| Targeting the `main` branch could mean fetching a Beta release. | ||
|
|
||
| </Callout> | ||
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| <Tab title="Manual integration" sync="manual-integration"> | ||
|
|
||
| 1. Fetch from GitHub the [latest Stable](https://github.com/adjust/adjust_signature_sdk/releases/latest) or [Beta](https://github.com/adjust/adjust_signature_sdk/releases) Dynamic XCFramework version. | ||
| 2. Unzip the archive and copy `AdjustSigSdk.xcframework` into your project’s directory. | ||
| 3. In Xcode, select your project in the **Project Navigator**. | ||
| 4. Select your target on the left-hand side. | ||
| 5. Select the **General** tab and expand the **Frameworks, Libraries and Embedded Content** group. | ||
|
|
@@ -72,6 +113,9 @@ Follow these steps to integrate the Signature library in your iOS project. | |
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Test your app {#test-your-app} | ||
|
|
||
| You can verify you have integrated the Signature library into your app using the [Adjust Testing Console](https://help.adjust.com/en/article/testing-console). | ||
|
|
@@ -100,7 +144,7 @@ To test your Signature library integration: | |
|
|
||
| If these fields are present and contain the correct information, you have successfully integrated the Signature library. If the fields display any other values, review the integration steps again or contact [email protected] for further assistance. | ||
|
|
||
| That’s it! You’ve successfully integrated the Signature library into your app. Once [two attribution windows have passed](https://help.adjust.com/en/article/attribution-windows), you can [enforce SDK signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation) to make sure that only signed requests are accepted by Adjust. | ||
| That’s it! You’ve successfully integrated the Signature library into your app. Once [two attribution windows have passed](https://help.adjust.com/en/article/attribution-windows), you can [enforce SDK Signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation) to make sure that only signed requests are accepted by Adjust. | ||
|
|
||
| ## Troubleshooting {#troubleshooting} | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,18 +43,59 @@ To update the Adjust Signature library, replace the existing Signature library w | |
| - They're no longer contributing to your install reporting. | ||
| - You've fully released a new version of your app (across all app platforms and stores). | ||
|
|
||
| ## Integrate the signature library (SDK v4 only) {#integrate-the-signature-library} | ||
| ## Integrate the signature library {#integrate-the-signature-library} | ||
|
|
||
| <Callout type="note"> | ||
|
|
||
| Adjust SDK v5 supports SDK signature verification natively. If you previously integrated the SDK signature library, you should uninstall it and remove all related code. | ||
| This step can be skipped if using SDK v5, as the Signature library is bundled by default for the majority of cases. Proceed only if prompted by the SDK or if a specific version is required. | ||
|
|
||
| </Callout> | ||
|
|
||
| Follow these steps to integrate the Signature library in your iOS project. | ||
| <Tabs> | ||
| <Tab title="Cocoapods" sync="cocoapods"> | ||
|
|
||
| 1. Download the [`AdjustSigSdk-iOS-tvOS-Dynamic.xcframework.zip` archive from GitHub](https://github.com/adjust/adjust_signature_sdk/releases/latest). | ||
| 2. Unzip the archive and copy the `AdjustSigSdk.xcframework` into your project’s directory. | ||
| The Signature libraries are released on [GitHub](https://github.com/adjust/adjust_signature_sdk/releases/) and are propagated to Cocoapods from version `3.20.1` onwards. To add the Signature library to your project, append the following to your `Podfile` (change the version with the [latest available](https://github.com/adjust/adjust_signature_sdk/releases/latest)): | ||
|
|
||
| ```ruby | ||
| pod 'AdjustSignature', '~> x.x.x' | ||
| ``` | ||
|
|
||
| Alternatively, Beta releases are available from version `3.24.1` onwards. To add the Signature library to your project, append the following to your `Podfile` (change the version with the [latest available](https://github.com/adjust/adjust_signature_sdk/releases)): | ||
|
|
||
| ```ruby | ||
| pod 'AdjustSignature', 'x.x.x-beta' | ||
| ``` | ||
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| <Tab title="Swift Package Manager" sync="swift-package-manager"> | ||
|
|
||
| SPM support is available from version `3.20.1` onwards. To add the Signature library, you need to add it to your Xcode project: | ||
|
|
||
| 1. Select **File —> Swift Packages —> Add Package Dependency** | ||
| 2. In the box that appears, enter the Signature’s GitHub address: https://github.com/adjust/adjust_signature_sdk | ||
| 3. Enter the version of the library you want to use in the **Version** field. Check the [releases page](https://github.com/adjust/adjust_signature_sdk/releases/latest) for the latest version. | ||
|
|
||
| Alternatively, SPM support is available for Beta releases from version `3.24.1` onwards. To add the Signature library, you need to add it to your Xcode project: | ||
|
|
||
| 1. Select **File —> Swift Packages —> Add Package Dependency** | ||
| 2. In the box that appears, enter the Signature’s GitHub address: https://github.com/adjust/adjust_signature_sdk | ||
| 3. Enter `release/vx.xx` in the **Branch** field. Replace `x.xx` with the latest major and minor version from the [releases page](https://github.com/adjust/adjust_signature_sdk/releases) e.g. `release/v3.24`. | ||
|
|
||
| <Callout type="note"> | ||
|
|
||
| Targeting the `main` branch could mean fetching a Beta release. | ||
|
|
||
| </Callout> | ||
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| <Tab title="Manual integration" sync="manual-integration"> | ||
|
|
||
| 1. Fetch from GitHub the [latest Stable](https://github.com/adjust/adjust_signature_sdk/releases/latest) or [Beta](https://github.com/adjust/adjust_signature_sdk/releases) Dynamic XCFramework version. | ||
| 2. Unzip the archive and copy `AdjustSigSdk.xcframework` into your project’s directory. | ||
| 3. In Xcode, select your project in the **Project Navigator**. | ||
| 4. Select your target on the left-hand side. | ||
| 5. Select the **General** tab and expand the **Frameworks, Libraries and Embedded Content** group. | ||
|
|
@@ -72,6 +113,9 @@ Follow these steps to integrate the Signature library in your iOS project. | |
|
|
||
| That’s it! The Signature library is now integrated into your project. | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Test your app {#test-your-app} | ||
|
|
||
| You can verify you have integrated the Signature library into your app using the [Adjust Testing Console](https://help.adjust.com/en/article/testing-console). | ||
|
|
@@ -100,7 +144,7 @@ To test your Signature library integration: | |
|
|
||
| If these fields are present and contain the correct information, you have successfully integrated the Signature library. If the fields display any other values, review the integration steps again or contact [email protected] for further assistance. | ||
|
|
||
| That’s it! You’ve successfully integrated the Signature library into your app. Once [two attribution windows have passed](https://help.adjust.com/en/article/attribution-windows), you can [enforce SDK signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation) to make sure that only signed requests are accepted by Adjust. | ||
| That’s it! You’ve successfully integrated the Signature library into your app. Once [two attribution windows have passed](https://help.adjust.com/en/article/attribution-windows), you can [enforce SDK Signature validation](https://help.adjust.com/en/article/sdk-signature#enforce-signature-validation) to make sure that only signed requests are accepted by Adjust. | ||
|
|
||
| ## Troubleshooting {#troubleshooting} | ||
|
|
||
|
|
||