# MobilePlatformApplication <div class="note"> <h4>Note</h4> <p>Please contact Shopify Support to enable this scope for your app</p> </div> <p>You can use the <code>MobilePlatformApplication</code> resource to enable <a href="https://developer.apple.com/documentation/security/shared_web_credentials"> shared web credentials</a> for Shopify iOS apps, as well as to create <a href="https://developer.apple.com/ios/universal-links/">iOS universal link</a> or <a href="https://developer.android.com/training/app-links/">Android app link</a> verification endpoints for merchant Shopify iOS or Android apps. Shared web credentials let iOS users access a native app after logging into the respective website in Safari without re-entering their username and password. If a user changes their credentials in the app, then those changes are reflected in Safari. You must use a custom domain to integrate shared web credentials with Shopify. With each platform's link system, users can tap a link to a shop's website and get seamlessly redirected to a merchant's installed app without going through a browser or manually selecting an app. </p> <p>For full configuration instructions on iOS shared web credentials, see the <a href="https://developer.apple.com/documentation/security/password_autofill/setting_up_an_app_s_associated_domains">associated domains setup</a> technical documentation. <p>For full configuration instructions on iOS universal links or Android App Links, see the respective <a href="https://developer.apple.com/documentation/uikit/core_app/allowing_apps_and_websites_to_link_to_your_content">iOS universal link</a> or <a href="https://developer.android.com/training/app-links/verify-site-associations">Android app link</a> technical documentation. ## Resource Properties ### MobilePlatformApplication * id: Unique numeric identifier for the mobile platform application. * Type: x-string * Example: 915396206 * application_id: iOS App ID or Android application ID of the application. * Type: x-string * Example: "A1B2C3D4.com.domainname.applicationname" * platform: The platform of the application. * Type: x-string * Example: "ios" * sha256_cert_fingerprints: The SHA256 fingerprints of the app’s signing certificate. (Android only) * Type: x-string * Example: ["50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42"] * enabled_universal_or_app_links: Whether the application supports iOS universal links and Android App Links. If true, then URLs can be set up to link directly to the application. If false, then URLs can't link directly to the application. * Type: x-string * Example: true * enabled_shared_webcredentials: Whether the application supports iOS shared web credentials. * Type: x-string * Example: {"enabled_shared_webcredential"=>true} * enabled_app_clips: Whether the application supports iOS app clips. * Type: x-string * Example: {"app_clips_enabled"=>true} * app_clip_application_id: iOS App ID of the app clip. * Type: x-string * Example: "A1B2C3D4.com.domainname.applicationname" ## List all of the mobile platform applications associated with the app List the mobile platform applications ### Endpoint /admin/api/#{api_version}/mobile_platform_applications.json (GET) ### Parameters * api_version (required): ### Responses #### 200 List all of the mobile platform applications associated with the app Examples: ##### List all of the mobile platform applications for the app Request: ``` GET /admin/api/unstable/mobile_platform_applications.json ``` Response: ``` HTTP/1.1 200 OK {"mobile_platform_applications":[{"id":1066176000,"application_id":"X1Y2.ca.domain.app","platform":"ios","created_at":"2025-01-02T11:11:11-05:00","updated_at":"2025-01-02T11:11:11-05:00","sha256_cert_fingerprints":[],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true,"enabled_app_clips":false,"app_clip_application_id":null},{"id":1066176001,"application_id":"com.example","platform":"android","created_at":"2025-01-02T11:11:11-05:00","updated_at":"2025-01-02T11:11:11-05:00","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":false,"enabled_app_clips":false,"app_clip_application_id":null}]} ``` ## Create a mobile platform application Create a mobile platform application ### Endpoint /admin/api/#{api_version}/mobile_platform_applications.json (POST) ### Parameters * api_version (required): ### Responses #### 201 Create a mobile platform application Examples: ##### Create a mobile platform application for Android Request: ``` POST /admin/api/unstable/mobile_platform_applications.json {"mobile_platform_application":{"platform":"android","application_id":"com.example","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true}} ``` Response: ``` HTTP/1.1 201 Created {"mobile_platform_application":{"id":1066176002,"application_id":"com.example","platform":"android","created_at":"2025-01-02T11:11:12-05:00","updated_at":"2025-01-02T11:11:12-05:00","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":false,"enabled_app_clips":false,"app_clip_application_id":null}} ``` ##### Create mobile platform application for iOS Request: ``` POST /admin/api/unstable/mobile_platform_applications.json {"mobile_platform_application":{"platform":"ios","application_id":"X1Y2.ca.domain.app","enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true}} ``` Response: ``` HTTP/1.1 201 Created {"mobile_platform_application":{"id":1066176003,"application_id":"X1Y2.ca.domain.app","platform":"ios","created_at":"2025-01-02T11:11:13-05:00","updated_at":"2025-01-02T11:11:13-05:00","sha256_cert_fingerprints":[],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true,"enabled_app_clips":false,"app_clip_application_id":null}} ``` ## Get a mobile platform application Get a mobile platform application ### Endpoint /admin/api/#{api_version}/mobile_platform_applications/{mobile_platform_application_id}.json (GET) ### Parameters * api_version (required): * mobile_platform_application_id (required): ### Responses #### 200 Get a mobile platform application Examples: ##### Get a mobile platform application Request: ``` GET /admin/api/unstable/mobile_platform_applications/1066175997.json ``` Response: ``` HTTP/1.1 200 OK {"mobile_platform_application":{"id":1066175997,"application_id":"X1Y2.ca.domain.app","platform":"ios","created_at":"2025-01-02T11:11:09-05:00","updated_at":"2025-01-02T11:11:09-05:00","sha256_cert_fingerprints":[],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true,"enabled_app_clips":false,"app_clip_application_id":null}} ``` ## Update a mobile platform application Update a mobile platform application ### Endpoint /admin/api/#{api_version}/mobile_platform_applications/{mobile_platform_application_id}.json (PUT) ### Parameters * api_version (required): * mobile_platform_application_id (required): ### Responses #### 200 Update a mobile platform application Examples: ##### Update a Mobile Platform Application for Android Request: ``` PUT /admin/api/unstable/mobile_platform_applications/1066175998.json {"mobile_platform_application":{"id":1066175998,"application_id":"com.example.news.app","platform":"android","created_at":"2025-01-02T11:11:09-05:00","updated_at":"2025-01-02T11:11:09-05:00","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":false,"enabled_app_clips":false,"app_clip_application_id":null}} ``` Response: ``` HTTP/1.1 200 OK {"mobile_platform_application":{"application_id":"com.example.news.app","platform":"android","sha256_cert_fingerprints":["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":false,"id":1066175998,"created_at":"2025-01-02T11:11:09-05:00","updated_at":"2025-01-02T11:11:10-05:00","enabled_app_clips":false,"app_clip_application_id":null}} ``` ##### Update a Mobile Platform Application for iOS Request: ``` PUT /admin/api/unstable/mobile_platform_applications/1066175996.json {"mobile_platform_application":{"id":1066175996,"application_id":"A1B2.ca.domain.app","platform":"ios","created_at":"2025-01-02T11:11:08-05:00","updated_at":"2025-01-02T11:11:08-05:00","sha256_cert_fingerprints":[],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true,"enabled_app_clips":false,"app_clip_application_id":null}} ``` Response: ``` HTTP/1.1 200 OK {"mobile_platform_application":{"application_id":"A1B2.ca.domain.app","platform":"ios","sha256_cert_fingerprints":[],"enabled_universal_or_app_links":true,"enabled_shared_webcredentials":true,"id":1066175996,"created_at":"2025-01-02T11:11:08-05:00","updated_at":"2025-01-02T11:11:09-05:00","enabled_app_clips":false,"app_clip_application_id":null}} ``` ## Delete a mobile platform application Delete a mobile platform application ### Endpoint /admin/api/#{api_version}/mobile_platform_applications/{mobile_platform_application_id}.json (DELETE) ### Parameters * api_version (required): * mobile_platform_application_id (required): ### Responses #### 200 Delete a mobile platform application Examples: ##### Delete a mobile platform application Request: ``` DELETE /admin/api/unstable/mobile_platform_applications/1066175999.json ``` Response: ``` HTTP/1.1 200 OK {} ```