Mini App Share Link

getTossShareLink The function converts a user-defined path into a share link that can be opened in the Toss appIf you send this link to someone else, the Toss app will launch and move directly to the specified deep-link screenYou can.

If the Toss app is not installed, it works as follows.

• iOS → App Storego to
• Android → Play Storego to

The path should point to an internal Toss app screen deep link format. For example, you can write it as below.

intoss://<app name>
intoss://<app name>/about?name=test

Also ogImageUrlIf you specify it, when shared on external platforms such as SNS and messengers, the preview (OG image) can be set directly. Because OG images are cropped and cached differently depending on the platform, please follow the guidelines below so they are displayed as intended when shared.

• The image URL must start with https://a absolute pathmust.
• Recommended size by platform · For detailed rules such as aspect ratio, file format, and file size, check the OG image rules in the internal documentation and apply them.

If OG images are configured incorrectly, the preview may appear different from what you intended, or may not appear at all on some platforms, so please be careful.

Cache notes

External platforms cache OG metadata (image/title/description), so changes to a link that has already been shared may not be reflected immediately. If you need them reflected sooner, use the debugger toolprovided by each platform to clear the cache directly.

• Kakao Debugger → https://developers.kakao.com/tool/debugger/sharing
• Facebook Debugger → https://developers.facebook.com/tools/debug/

Signature

function getTossShareLink(url: string, ogImageUrl?: string): Promise<string>;

Parameters

• url · Required

  This is the path you want to open with a deep link. intoss:// must be a string that starts with
• ogImageUrl string

  The image URL to display in the preview (OG) when shared. https:// must be an absolute path that starts with

Return value

• Promise<string>

  deep_link_valueReturns a Toss share link containing

Example

js

import { share, getTossShareLink } from '@apps-in-toss/web-framework';

async function handleShare() {
  const tossLink = await getTossShareLink(
    'intoss://my-app',
    'https://static.toss.im/icons/png/4x/icon-share-dots-mono.png',
  );

  // Share the generated link as a message.
  await share({ message: tossLink });
}

React

import { share, getTossShareLink } from '@apps-in-toss/web-framework';
import { Button } from '@toss/tds-mobile';

function ShareButton() {
  async function handleClick() {
    const tossLink = await getTossShareLink(
      'intoss://my-app',
      'https://static.toss.im/icons/png/4x/icon-share-dots-mono.png',
    );

    // Share the generated link as a message.
    await share({ message: tossLink });
  }

  return <Button onClick={handleClick}>Share</Button>;
}

React Native

import { share, getTossShareLink } from '@apps-in-toss/framework';
import { Button } from '@toss/tds-react-native';

function ShareButton() {
  async function handleClick() {
    const tossLink = await getTossShareLink(
      'intoss://my-app',
      'https://static.toss.im/icons/png/4x/icon-share-dots-mono.png',
    );

    // Share the generated link as a message.
    await share({ message: tossLink });
  }

  return <Button onPress={handleClick}>Share</Button>;
}

Try the sample app

apps-in-toss-examples from the repository with-share-link Download the code, or scan the QR code below to try it yourself.

QR code link: intoss://with-share-link

Test guide before app launch

intoss:// The scheme is accessible only after the app is officially launched. For testing features before launch, you must use the test scheme (QR code) generated on upload.

① In the QR code deploymentId check

A new deploymentIdis issued every time you upload an app bundle. In the test scheme, _deploymentId is a required parameter.

Example:

intoss-private://appsintoss?_deploymentId=0198c000-68c3-7d2b-0000-2c00000005ec

② Test by applying path/query to the scheme

• When a subpath is applied:

intoss-private://appsintoss/path/pathpath?_deploymentId=0198c000-68c3-7d2b-0000-2c00000005ec

• When applying query parameters: queryParams must be URL-encoded.

intoss-private://appsintoss?_deploymentId=0198c000-68c3-7d2b-0000-2c00000005ec&queryParams=%7B%22categoryKey%22%3A%22