How to integrate login-free service

Description

The login-free service is to generate the corresponding login-free URL based on the information received from your service when the user accesses Loyalty3.

Loyalty3 synchronizes the user's login status through the login-free URL generated by this interface.

Use Case

Users can access Loyalty3 from your application without the need to log in again. They can directly retrieve user-related information, such as claimed benefits/NFTs and eligibility status, without requiring reauthentication.

Development

The following is the overall flow of interaction between your service and Loyalty3:

To complete the integration, you need to complete the following steps, including:

1. Configure the verify wallet address

2. Construct request parameters, signature, redirect link

3. Concatenate URLs

Step 1

Configure the address used for signature verification to ensure the legitimacy of your requests.

In Setting -> Developer Setting, configure the verify wallet address, which must be a ethereum address.

Step 2

Construct request parameters, signature, redirect link.

Parameters

Build the necessary parameters for each request, including:

Parameters	Type	Example	Description
account_id	string	0x6183b0e158e5e591b1d634E64861B8700F90ecb3	User unique identifier, corresponding to a single user and is immutable.
account_type	string	EVM_ADDRESS	Type of account, currently only supports EVM_ADDRESS.
project_id	string	91	The project ID assigned to you when you register with Loyalty3.
timestamp	number	1687766502	Current second-level Unix timestamp.

Example:

{
    "account":{
        "account_id":"0x6183b0e158e5e591b1d634E64861B8700F90ecb3"
       "account_type":"EVM_ADDRESS",
    }，
    "project_id":91,
    "timestamp":1687766502
}

Signature

Sign using the verify wallet address set in Step 1, and the plaintext message needs to be processed similarly to signing with MetaMask.

Here is an example of constructing a signature:

func Sign(w http.ResponseWriter, r *http.Request) {
    body, err := io.ReadAll(r.Body)
    if err != nil {
       http.Error(w, http.StatusText(500), 500)
       return
    }
    param := &SignParam{}
    err = json.Unmarshal(body, param)
    if err != nil {
       http.Error(w, http.StatusText(500), 500)
       return
    }

    keyStore := keystore.NewKeyStore("./keystore", keystore.StandardScryptN, keystore.StandardScryptP)
    if len(keyStore.Accounts()) == 0 {
       fmt.Println("no account")
       http.Error(w, http.StatusText(500), 500)
       return
    }

    loginParam := &LoginParam{
       ProjectID: 91, //project id registered on loyalty
       Account: &Account{
          AccountType: "EVM_ADDRESS",  // fixed for now
          AccountId:   param.Address,
       },
       Timestamp: time.Now().Unix(),
    }

    payload, _ := json.Marshal(loginParam)
    sigbts, err := sig.GetThirdPartyAPIInvokeSig(payload, keyStore, keyStore.Accounts()[0], "123456")
    if err != nil {
       fmt.Println(err)
       http.Error(w, http.StatusText(500), 500)
       return
    }
    doResponse(w, nil, &SignResp{
       Msg: string(payload),
       Sig: hexutil.Encode(sigbts),
    })
    return
}

func GetThirdPartyAPIInvokeSig(param []byte, ks *keystore.KeyStore, acct accounts.Account, pwd string) ([]byte, error) {
    hash := EthSignHash(param)
    return ks.SignHashWithPassphrase(acct, pwd, hash)
}

func EthSignHash(data []byte) []byte {
    msg := fmt.Sprintf("\x19Ethereum Signed Message:\n%d%s", len(data), data)
    return crypto.Keccak256([]byte(msg))
}

Redirect Link

The redirect link represents the URL of the page to which users will be redirected upon entering Loyalty3.

Example:

https://loyalty3.io/project/90/drop-detail/254

Step 3

Concatenate the URL with the parameters, signature, and redirect link constructed in Step 2.

<Redirectlink>?params=<param string>&sig=<sig hex>

NOTE: The order of the parameters can not be changed.

URL Example:

https://loyalty3.io/project/90/drop-detail/254?params={\"account\":{\"account_id\":\"0x93C0957C3613D778aD42E386Ea8EF8b7D2E1301e\",\"account_type\":\"EVM_ADDRESS\"},\"project_id\":80,\"timestamp\":1687859402}&sig=0xf0da25d499dd77be8f0c81aca8434c3c71f03f0ab648129b2bea055f13184a3e35f6550811c393e21d7d5ba376a41089669e0d6f5231f433bd3a97205903a34a01

🎉 Congratulations! Through this URL, users will be redirected to the specified page and they can access Loyalty3 from your application without the need to log in again!

Frequently Asked Questions

I am unable to redirect properly. How can I know what the problem is?

You can know the issue by analyzing the returned error code.

Error Code	Description
INVALID_SIG	Incorrect signature.
INVALID_PARAM	Incorrect parameters.
PROJECT_NOT_EXIST	The project does not exist.
TOKEN_EXPIRED	The token has expired. Tokens are valid for 14 days.

How to obtain project_id?

1. Login to your Loyalty3 account.

2. Go to the "Setting" section.

3. Navigate to the "Developer Setting" .

4. Look for the project ID associated with your project.