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]!
iykRef
in the URL, use GET /refs/:id
, API docs linked hereGET /chips/find
, API docs linked herePATCH /chips
endpoint with your API key and chip UID to set this.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.redirectUrl
, tap the chip using your phone.{YOUR_DEV_URL}?iykRef=ABCDEF
.iykRef
you see in the URL as a query parameter (like ABCDEF
) is important.iykRef
acts as the :id
path parameter when you want to fetch details.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 sharedlinkedToken
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]
otp
which can be used to validate a tap server-side, or authenticate transfers of the NFTotp
from the validated ref response, and check on your backend that it is valid using the endpoint GET /otps/:id
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