Inviting Users via QR Code with Simplici APIs

This guide provides a comprehensive walkthrough on how to onboard your application on Simplici, generate a QR code, retrieve the QR code URL using Simplici UI, generate an access token, and finally, invite users using the Satschel API.

Step 1: Onboarding on Simplici

1. Navigate to Simplici Onboarding.
2. 
3. Follow the onboarding flow and fill out the required information. This process will set up your application for QR code generation and API access.

Step 2: Generating a QR Code

After completing the onboarding process, use the Simplici UI to generate a QR code:

1. Click on the "Generate" button in the Simplici UI.
2. Once the QR code is generated, copy its URL for later use.

Url E.g https://secure.simplici.io/65f363bde437138e2894fa32?type=qr

Here qrId is 65f363bde437138e2894fa32

Step 3: Generating an Access Token

To call the API, you must first generate an access token:

1. Refer to the Getting Started documentation on Simplici.
2. Follow the steps to authenticate and receive an access token.
3. Include the access token in the header for subsequent API calls.

Step 4: Inviting Users via API

To invite users, make a POST request to the Satschel API endpoint:

• URL: https://api.satschel.com/v2/pipelines/qr-invite
• Method: POST
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer YOUR_ACCESS_TOKEN
• Request Body:

jsonCopy code
{
    "users": {
        "headers": ["First Name", "Last Name", "Email", "Mobile", "Country Code", "Dollars Invested"],
        "rows": [
                ["Jane", "Doe", "[email protected]", "5551234567", "+1", "100"]
        ]
    },
    "qrId": "YOUR_QR_ID",
    "metadata": {
        "test": "ihyvbhakhs",
        "noram": "dsdb"
    },
    "alerts": {
        "email": true,
        "text": false}
}

Replace YOUR_ACCESS_TOKEN with the access token generated in Step 3 and YOUR_QR_ID with the QR code ID from Step 2.

• Response:

{
    "message": "ok",
    "data": [
        {
            "session": "SESSION_ID",
            "userId": "USER_ID",
            "code": "INVITATION_CODE",
            "countryCode": "+91",
            "phone": "PHONE_NUMBER",
            "email": "EMAIL",
            "type": "complex",
            "token": "INVITATION_TOKEN"
        }
    ]
}

Step 5: Using the Invitation

With the session ID from the response, construct the URL to direct users to their personalized invitation:

• Invitation URL: https://secure.simplici.io/INVITATION_CODE?type=complex

Replace INVITATION_CODE with the code ID obtained from the invitation response.

Additional Notes

• The metadata field can be used to send additional parameters, which will be returned via webhook.
• Control email and SMS notifications by adjusting values in the alerts object.

This guide provides the necessary steps to integrate with Simplici and Satschel APIs for inviting users via QR codes. Adjust the steps as needed based on your application's requirements and the specific implementation details of both APIs.