The following process is what is most common when building tap experiences. Refer to the docs here for the endpoints referenced below: **https://docs.iyk.app/**

If you have any questions, feel free to reach out to [email protected]!

Prerequisites:

• You have an IYK chip to test with.
• You have an IYK API Key
  • To generate one, please login to platform and create your own (Team Dropdown top-left > Settings > API Keys) or email [email protected]

Step 1: Identify the Chip you want to use for Development

• Tap an IYK-powered chip with your phone to retrieve the UID
  • If it hasn’t been configured yet, you will be able to copy the UID from the resulting webpage
  • If it has already been configured, inspect the URL params and use one of the below endpoints to get the UID:
    • If there’s an iykRef in the URL, use GET /refs/:id, API docs linked here
    • Otherwise, pass all of the URL params to GET /chips/find, API docs linked here
  • You can also find UIDs via the API (1, 2), or in your Platform dashboard

Step 2: Set the Redirect URL for the Chip

• You need to set the redirect URL of the chip so that it knows where to redirect when it's tapped.
• Use the PATCH /chips endpoint with your API key and chip UID to set this.
• Set the redirectUrl of the chip to your local development URL. Tools like ngrok or localtunnel can help you expose your local development environment to the web.

Step 3: Tap the Chip with Your Phone

• After setting up the redirectUrl, tap the chip using your phone.
• Your phone should redirect to the URL in the format {YOUR_DEV_URL}?iykRef=ABCDEF.

Step 4: Understand the Redirect

• The iykRef you see in the URL as a query parameter (like ABCDEF) is important.
• This iykRef acts as the :id path parameter when you want to fetch details.
• Use the endpoint GET /refs/:id to get details using the iykRef value
  • isValidRef will be true the first time the ref is fetched. Use this value on your frontend page or in the server-side fetcher to determine if the link has been shared
  • linkedToken will be the reference for the NFT that is linked to the specific chip. If you don’t see one and are expecting to use it, please contact [email protected]
    • If the ref is valid, this object will also contain an otp which can be used to validate a tap server-side, or authenticate transfers of the NFT

Step 5: Claim the related token (if needed)

• Use the otp from the validated ref response, and check on your backend that it is valid using the endpoint GET /otps/:id
  • If the otp exists and isn’t expired, it means that the tap is valid and you can transfer ownership of the linkedToken using your API key and the POST phygitals/transfer endpoint