Loyi API Reference
    Loyi API Reference
    • Getting Started
    • Architecture
    • User
      • Users Overview
      • Create user
        POST
      • Get users
        GET
      • Get user
        GET
      • Update user
        PUT
      • Delete user
        DELETE
    • Reward
      • Rewards Overview
      • Create reward
        POST
      • Get rewards
        GET
      • Delete reward
        DELETE
      • Create entry pass code
        POST
      • Get entry pass code
        GET
      • Airdrop reward
        PUT
      • Award reward
        POST
      • Redeem rewards
        GET
    • Collection
      • Collection Overview
      • Create collection
        POST
      • Get collections
        GET
      • Get collection
        GET
      • Update collection
        PUT
      • Delete collection
        DELETE
      • Get rewards
        GET
    • Collectible
      • Claim collectible
        POST
      • Get collectibles
        GET
    • Quest
      • Quest Overview
      • Create quest
      • Get quests
      • Get quest
      • Update quest
      • Delete quest
      • Get participants
      • Accept quest
      • Submit answers
      • Get answers
    • Leaderboard
      • Leaderboard Overview
      • Get leaderboard
    • Leveling
      • Get leveling configuration
      • Configure leveling
      • Get milestone levels
      • Create milestone level
      • Get milestone level
      • Update milestone level
      • Delete milestone level

    Getting Started

    Loyi is a Gamification Engine that allows the users to easily create or amplify loyalty solutions. This API covers all aspects of the Loyi Gamification Engine, such as user, rewards, quests, collections and leaderboard management.

    Blockchain Support#

    Loyi offers optional blockchain support. This allows rewarding participants with unique tokens.

    Security Model#

    To make calls to the Loyi API, you will need to generate an API key and whitelist your domains on the Loyi dashboard. Use the API key in the x-api-key header of your requests and the whitelisted domains in the origin header. Any requests made from an origin which has not been whitelisted will be rejected with a 401 status code. The API Key is a secret.

    All endpoints require:#

    x-api-key header with valid API key
    origin header matching whitelisted domains

    Response Codes:#

    401 Unauthorized for invalid/missing credentials
    404 Not Found for invalid resource IDs
    400 Bad Request for validation errors

    Try It#

    To try out the endpoints in the interactive API client, you might have to disable the default agent configuration. Follow these steps to do that:
    1.
    Click on the agent options at the bottom-right corner.
    2.
    Disabled auto-select.
    3.
    Select cloud agent as the agent.
    Modified at 2025-03-27 16:37:31
    Next
    Architecture
    Built with