v1.4.7

Release Date

Nov 6th 2025 07:00 in UTC

Note

What's improved

  • OA Promotion Phase 3 Support

OA Promotion Phase 3 Guide

Please refer to the following guide and proceed with the additional development and information submission.

Additional Development

  • Event Provider Callback (DappPortalSDK.getEventProvider())

  • Dapp Server REST API Implementation

Required Information Submission

  • API URL (required)

  • Custom Header (optional)

DappPortalSDK.getEventProvider()

Event Provider Callback for Mini Dapp Mission Completion

  • The purpose of this callback method is to verify mission completion on Dapp Portal side and automatically display a success banner when verification is successful.

const eventProvider = DappPortalSDK.getEventProvider();

// When the mission is completed
const eventId: string = "eventId";          // Unique event ID provided by Dapp Portal
const subMissionIndex: string = "1";        // Sub-mission index, starting from 0

await eventProvider.callback(eventId, subMissionIndex); // If verification is successful, a banner will be displayed automatically.

Parameters

Parameter
Type
Description

eventId

string

The unique identifier provided by Dapp Portal

subMissionIndex

string

The index of the sub-mission. Indexing starts from 0. For example: - Event item purchase Misson -> use subMissionIndex = "0" - Lv4 achievement Misson -> use subMissionIndex = "1"

Responses

N/A

  • If verification is successful, a banner will be displayed.

Dapp Server REST API Implementation Guide

To enable mission completion on the Dapp Portal charts, the Dapp server must provide an API endpoint that allows the Dapp Portal to verify whether a mission has been completed.

  • Information Required

    • API URL (required)

    • Custom Header (optional)

  • API Overview

    • Method: GET

    • Scheme: https

    • Read Timeout: 1s

      • If the Dapp Portal server does not receive a response within 1 second, the mission will be treated as failed.

  • Custom Header (optional)

    • You may include a custom header when the API is called.

    • There are no restrictions on header key/value format.

    • Only one custom header can be used, and it is optional.

    • ex) x-dapp-custom-key: gq8g0Ah1MD98

  • URL Format

    • Base URL: Dapp server URL

    • The $identifier as query parameter must be included.

    • $identifier is a placeholder that will be replaced by the user’s wallet address (in lowercase) by the Dapp Portal server.

    • ex) https://example.dapp.io/api/mission/1111?param=zzzz&identifier=$identifier

  • Response Body

    • Content Type: JSON

    • If the Dapp Portal server receives a successful response, the user is considered to have completed the mission.

      • Mission Complete

      • HTTP/1.1 200 OK
        {
          "result": true
        }
      • Mission Fail

      • HTTP/1.1 200 OK
        {
          "result": false
        }

Last updated