Get your engineers involved if using API

From the engineering standpoint, is just another RESTful API to be integrated with your product offering. The detailed instructions are available in our API documentationopen in new window, but at glance, the process to go through is as follows.

  1. Create a test program. For this you need access to If you do not have access, please contact your project manager to receive an invitation to your email.

  2. Generate a test API key, unlocking API access to all programs created in TEST mode.

  3. Use the test API key to grant virtual shares via the call to REST API, similar to the following example that issues 1 virtual share to email

    Click me to view the code
    curl --request POST \
      --url{programId}/grant-tokens \
      --header 'Content-Type: application/json' \
      --header 'x-api-key: {apiKey}' \
      --data '{
      "recipient": {
        "email": ""
      "reason": "Referral bonus",
      "amount": 1
  4. If you use the above example, replace the placeholders for {programId} and {apiKey} with what you created in the first two steps.

  5. Implement error handling based on the details in the API documentationopen in new window.

  6. Invest as much as necessary to solidify integration by making the call asynchronous and adding support for buffering and retries.

  7. Test according to the quality criteria that any other external integration of your service would require.

  8. Create a live program and live API key as you did in steps 1 and 2 for test mode.

  9. Ensure that configuration management does not expose API keys and that proper secret management is used.

  10. Go live and enjoy, not forgetting to inform the operations team about the new dependency that has been introduced.

The average integration is usually done in 1-3 calendar days.

Last Updated: