1. Add your app in SideShift
In Settings → Ads & Ecom, find SideShift App SDK and choose Add App. Paste your App Store link: SideShift fills in the app’s name, icon, bundle ID and website from the App Store. You can also enter them yourself. The app’s Setup tab then walks through each step below with your keys already filled in, and shows a green check as each one starts working. The SDK key (ss_pixel_…) goes in the app and is public, like a pixel code. The Orders API key (ss_orders_…) stays on your server.
The app shows Setup required until the SDK sends its first event and you connect App Store Connect. Both steps are required, because Apple sends renewals and refunds to SideShift only for an app with App Store Connect connected.
2. Install the SDK
Add the Swift package to your app: in Xcode choose File → Add Package Dependencies and pastehttps://github.com/SideShiftApp/sideshift-ios-sdk. The repository’s README is the full developer guide. Then configure it when the app launches:
app_install on the first open and app_open when the app comes back to the foreground. Events are queued on the device and retried when the network returns.
How an install finds its link
- A person taps a creator’s link. It opens the SideShift app link page,
https://app.sideshift.app/a/<code>. - Get the app copies the link and opens your App Store page.
- On the first open, the SDK reads the copied link. iOS may ask the person to allow the paste. The install is credited to that link.
- If the person already has your app, I already have it opens your website with
ssandss_clickin the URL. With universal links set up on that domain, iOS opens your app, andSideShift.handle(_:)credits the open to the link.
?ss=<code> without ss_click, is not credited. One link tap credits one install. The first install that opens with a click ID keeps it for its install and its later opens. Another install that opens with the same click ID is recorded, but it is not credited to the link. Without a link, an install is recorded but credited to no one. To turn off the pasteboard check, pass SideShift.Options(readsPasteboardOnInstall: false) to configure. Only already-installed apps opened through universal links are then credited.
More ways to credit an install
Every method below is exact. SideShift never guesses from a device’s details.Email and phone matching
When a person signs up or logs in, tell SideShift who they are. The SDK hashes the email and phone on the device before sending them:identify only after the person allows tracking in the App Tracking Transparency prompt. The SDK never shows the prompt. Your app asks with ATTrackingManager.requestTrackingAuthorization. Until the person allows tracking, the SDK keeps the latest hashes on the device and sends them at the next launch or foreground after permission. To send identify without tracking permission, pass SideShift.Options(identityNeedsTrackingPermission: false) to configure. Do this only if your own App Store privacy review supports it.
SideShift gets the email two ways:
- In the SideChat DM. In the campaign’s SideChat settings, choose Ask for their email, so the opening message asks people to reply with their email for the link. A reply with an email gets the link, and SideShift keeps only its hash.
- On the link page, which has an optional email field.
The Paste button
Apple’s system Paste button reads the copied link with no “Allow Paste” prompt. Put it in onboarding, for example next to “Got here from a creator? Tap to claim their offer”:Creator codes
A brand can give each creator link a code, such asJANE20, when it creates the link. If your app has a code field, pass what the person types:
See how much is matched
The app’s Tracking tab lists each creator’s link with the installs SideShift matched by any of these methods. With App Store Connect connected, it also shows Apple’s download count and the share that was matched.App Store installs from Apple
Apple can also count installs per creator link, without the SDK. In the app’s Tracking tab, under App Store installs, connect App Store Connect:- Provider token: the number after
pt=in any campaign link you make in App Store Connect → App Analytics → Campaigns. - App Store Connect API key: in Users and Access → Integrations → App Store Connect API, create a key with the App Manager or Sales and Reports role. Enter its issuer ID and key ID, and paste the
.p8file.
ct). SideShift reads Apple’s App Store Installations and Deletions report every few hours and shows first-time downloads and redownloads per creator. Apple reports a day or two later, counts only people who share analytics with developers, and leaves out rows under five people, so these counts run lower than real installs. Orders are credited by the SDK.
App Store purchases and renewals
The SDK sends every App Store purchase it sees, as Apple signed it: new purchases, purchases on other devices, renewals and refunds. SideShift checks Apple’s signature and your bundle ID, so these are verified sales with no server of your own. CallSideShift.track(result) right after product.purchase() to send a purchase at once instead of at the next launch:
REFUND_REVERSED notification restores a refunded sale.
Who gets credit: a purchase is credited to the last creator link the install came from in the 7 days before it. Every renewal of that subscription stays with the same creator, unless the person comes through another creator’s link in the 7 days before a renewal. Sandbox and TestFlight purchases are recorded as samples and earn no commission.
3. Send orders from your server
Revenue and commissions come only from verified orders: App Store purchases signed by Apple (above), or orders your server sends. A purchase the app reports withtrackPurchase is shown but never pays commission. If your server also reports App Store purchases, use Apple’s transaction ID as orderId, so SideShift counts each one once. Pass SideShift.installId to your server, for example with your sign-up or purchase request, and send it as visitorId:
Events
Server events
Events that happen on your backend, such as an approval, a payout or a renewal, can be sent with the Orders API key:eventId. If the app and your server both send an event, give both the same eventId (pass it to SideShift.track(_:eventId:)), and it is counted once. SideShift writes its own events with IDs that start with click_claim:, identity: or app_store_notification:. An event with an eventId that starts with one of these prefixes returns 400.