Myket Knowledge Base

https://myket.ir/kb/
Admin
This documentation repository provides technical guides, rules, and frequently asked questions for...
Tokens:120,198
Snippets:730
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start IabHelper Setup

Source: https://myket.ir/kb/pages/in-app-purchase-implementation-steps

Initiate the asynchronous setup process and handle the result via the OnIabSetupFinishedListener.

```java
mHelper.startSetup(new IabHelper.OnIabSetupFinishedListener()  {   
    public void onIabSetupFinished(IabResult result) {
    if (!result.isSuccess()) {         
        // Oh noes, there was a problem.         
        Log.d(TAG, "Problem setting up In-app Billing: " + result);
    }                     
    // Hooray, IAB is fully set up!
} });
```

--------------------------------

### myket://download/[PACKAGE_NAME]

Source: https://myket.ir/kb/pages/open-application-page-in-myket

Opens the application detail page and automatically starts the download process.

```APIDOC
## URI Scheme: myket://download/[PACKAGE_NAME]

### Description
Opens the application detail page in Myket and simultaneously triggers the download of the application.

### Parameters
- **PACKAGE_NAME** (string) - Required - The package name of the application to be downloaded.
```

--------------------------------

### Install Myket In-App Billing Module

Source: https://myket.ir/kb/pages/adding-inapp-purchase-in-react-native

Commands to install the required dependency using npm or yarn.

```bash
npm install iab-myket-reactnative
```

```bash
yarn add iab-myket-reactnative
```

--------------------------------

### Connect(RSAPublicKey: String)

Source: https://myket.ir/kb/pages/adding-inapp-purchase-in-react-native

Initializes the Myket billing service. This method is required before performing any other operations and returns a promise that rejects if the Myket app is not installed or the key is invalid.

```APIDOC
## Connect(RSAPublicKey: String)

### Description
Initializes the Myket billing service. This method is required before performing any other operations.

### Parameters
- **RSAPublicKey** (String) - Required - The RSA public key obtained from the Myket developer panel.

### Response
- **Promise** - Resolves on success, rejects if Myket is not installed or the key is invalid.
```

--------------------------------

### MyketSupportHelper.startSetup

Source: https://myket.ir/kb/pages/check-version-update-service

Initializes the Myket support helper to establish a connection with the Myket service.

```APIDOC
## MyketSupportHelper.startSetup

### Description
Initializes the connection to the Myket service. This must be called before any other operations.

### Method
void startSetup(OnMyketSetupFinishedListener listener)

### Parameters
- **listener** (OnMyketSetupFinishedListener) - Required - Callback invoked when the setup process completes.
```

--------------------------------

### MyketIAB.init

Source: https://myket.ir/kb/pages/%DB%8C%D9%88%D9%86%DB%8C%D8%AA%DB%8C-unity-%D8%A8%D8%A7-gradle

Initializes the Myket IAB service with the provided public key.

```APIDOC
## public static void init(string publicKey)

### Description
Initializes the Myket IAB service. This must be called before any other library function. Success triggers `billingSupportedEvent`, failure triggers `billingNotSupportedEvent`.

### Parameters
- **publicKey** (string) - Required - The public key obtained from the Myket developer panel.
```

--------------------------------

### Get Purchase Status

Source: https://myket.ir/kb/pages/iab-flutter

Check the status of a specific product.

```dart
Map<String, dynamic> result = await MyketIAP.getPurchase(sku: "gas", querySkuDetails: false);
```

```dart
IabResult purchaseResult = result[MyketIAP.RESULT];
Purchase purchase = result[MyketIAP.PURCHASE];
```

--------------------------------

### MyketIAB.init

Source: https://myket.ir/kb/pages/unity-with-gradle-fa

Initializes the billing service with the provided public key. Must be called before any other library functions.

```APIDOC
## public static void init(string publicKey)

### Description
Initializes the Myket billing service. Requires the public key from the Myket developer panel. Triggers billingSupportedEvent on success or billingNotSupportedEvent on failure.

### Parameters
- **publicKey** (string) - Required - The public key for the application.
```

--------------------------------

### Install Myket IAP Dependency

Source: https://myket.ir/kb/pages/iab-flutter

Add the dependency to your pubspec.yaml file.

```yaml
myket_iap: ^1.1.10
```

--------------------------------

### Configure Package Visibility

Source: https://myket.ir/kb/pages/in-app-purchase-implementation-steps

Required for targetSdkVersion 30 and above to ensure the app can communicate with Myket when installed.

```xml
     <queries>
		<package android:name="ir.mservices.market" />
		<intent>
			<action android:name="ir.mservices.market.InAppBillingService.BIND" />
			<data android:mimeType="*/*" />
		</intent>
	</queries>
```

--------------------------------

### Run Prebuild

Source: https://myket.ir/kb/pages/adding-inapp-purchase-in-react-native

Commands to run prebuild after adding the plugin.

```bash
npx expo prebuild
```

```bash
yarn expo prebuild
```

--------------------------------

### GET /api/partners/applications/{PACKAGE_NAME}/products

Source: https://myket.ir/kb/pages/manage-sku-items

دریافت لیست محصولات درون‌برنامه‌ای ثبت شده برای یک پکیج خاص.

```APIDOC
## [GET] /api/partners/applications/{PACKAGE_NAME}/products

### Description
این سرویس لیست محصولات درون‌برنامه‌ای ثبت شده برای یک برنامه را بازمی‌گرداند. این فراخوانی باید به صورت Server-to-Server انجام شود.

### Method
GET

### Endpoint
https://developer.myket.ir/api/partners/applications/{PACKAGE_NAME}/products

### Parameters
#### Path Parameters
- **PACKAGE_NAME** (string) - Required - نام پکیج برنامه (مثال: org.medrik.roosterwars)

#### Query Parameters
- **limit** (integer) - Optional - تعداد آیتم‌های برگشتی (پیش‌فرض: 100، حداکثر: 1000)
- **offset** (integer) - Optional - شماره صفحه برگشتی (پیش‌فرض: 0)

#### Headers
- **X-Access-Token** (string) - Required - توکن صحت‌سنجی دریافت شده از پنل توسعه‌دهندگان

### Response
#### Success Response (200)
- **skus** (array) - لیست محصولات
- **totalCount** (integer) - تعداد کل محصولات

#### Response Example
{
    "skus": [{
            "skuId": "GEM1",
            "englishTitle": "Gem Level 1",
            "farsiTitle": "الماس ۱۰۰۰ تومانی مرحله اول",
            "price": 10000,
            "creationDate": "2024-07-27T00:00:05.41",
            "isActive": false
        }],
    "totalCount": 2
}
```

--------------------------------

### Connect to Myket Service

Source: https://myket.ir/kb/pages/java

Establish a connection to the billing service using startSetup and handle the result via OnIabSetupFinishedListener.

```java
mHelper.startSetup(new IabHelper.OnIabSetupFinishedListener() {
            public void onIabSetupFinished(IabResult result) {
                 
            }
        });
}
```

--------------------------------

### GET /api/partners/applications/{packageName}/release-bundle

Source: https://myket.ir/kb/pages/developer-cd

Retrieves a list of all uploaded release bundles for a specific application, with optional filtering by status and pagination support.

```APIDOC
## [GET] /api/partners/applications/{packageName}/release-bundle

### Description
Retrieves a list of all release bundles associated with a specific application package name. Supports filtering by release status and pagination.

### Method
GET

### Endpoint
https://developer.myket.ir/api/partners/applications/{packageName}/release-bundle?status={status}&offset={offset}&limit={limit}

### Parameters
#### Path Parameters
- **packageName** (string) - Required - The package name of the application (e.g., ir.mservices.mybook).

#### Query Parameters
- **status** (string) - Optional - Filter by status: JustCreated, WaitingForApproval, Rejected, Approved, RolledBack.
- **offset** (integer) - Required - Pagination offset (must be > 0).
- **limit** (integer) - Required - Number of items to return (range 1-20).

### Response
#### Success Response (200)
- **eol** (boolean) - Indicates if the end of the list has been reached.
- **releases** (array) - List of release objects containing title, status, createdAt, id, and version details.

#### Error Response (401)
- Returned if the package does not exist or does not belong to the authenticated user.
```

--------------------------------

### GET /api/partners/applications/{PACKAGE_NAME}/purchases/products/{SKU_ID}/verify

Source: https://myket.ir/kb/pages/server-to-server-payment-validation-api

Verifies the status of an in-app purchase by providing the package name, product SKU, and purchase token.

```APIDOC
## POST /api/partners/applications/{PACKAGE_NAME}/purchases/products/{SKU_ID}/verify

### Description
Validates an in-app purchase transaction status. This request must be performed server-to-server to maintain security.

### Method
POST

### Endpoint
https://developer.myket.ir/api/partners/applications/{PACKAGE_NAME}/purchases/products/{SKU_ID}/verify

### Parameters
#### Path Parameters
- **PACKAGE_NAME** (string) - Required - The package name of the application (e.g., org.medrik.roosterwars)
- **SKU_ID** (string) - Required - The product SKU identifier (e.g., GEM2)

#### Request Body
- **tokenId** (string) - Required - The purchase token received from the in-app purchase process

### Request Example
{
  "tokenId": "{TOKEN_ID}"
}

### Response
#### Success Response (200)
- **kind** (string) - The type of purchase
- **purchaseTime** (long) - Timestamp of the transaction
- **developerPayload** (string) - Payload sent during purchase initiation
- **purchaseState** (integer) - 0 for success, 1 for failure
- **consumptionState** (integer) - 0 for non-consumable, 1 for consumable

#### Response Example
{
  "kind": "androidpublisher#productPurchase",
  "purchaseTime": 1492839267000,
  "developerPayload": "",
  "purchaseState": 0,
  "consumptionState": 1
}
```

--------------------------------

### Initialize Myket Billing

Source: https://myket.ir/kb/pages/unity-with-gradle-fa

Initializes the billing service with the public key from the Myket developer panel.

```csharp
public static void init(string publicKey)
```

--------------------------------

### Run Locally

Source: https://myket.ir/kb/pages/adding-inapp-purchase-in-react-native

Commands to test the application on an emulator or device.

```bash
npx expo run:android
```

```bash
yarn expo run:android
```

--------------------------------

### دریافت لیست محصولات درون‌برنامه‌ای

Source: https://myket.ir/kb/pages/manage-sku-items

فراخوانی متد GET برای دریافت محصولات ثبت شده. این سرویس باید از سمت سرور فراخوانی شود.

```HTTP
[GET]
[Header: X-Access-Token]


https://developer.myket.ir/api/partners/applications/{PACKAGE_NAME}/products?limit=10&offset=0
```

--------------------------------

### myket://details?id=[PACKAGE_NAME]

Source: https://myket.ir/kb/pages/open-application-page-in-myket

Opens the application detail page in the Myket store for the specified package.

```APIDOC
## URI Scheme: myket://details?id=[PACKAGE_NAME]

### Description
Opens the Myket store page for a specific application. This is useful for directing users to your app page, such as when prompting them to install a new version.

### Parameters
- **id** (string) - Required - The package name of the application.
```
Tokens:
Raw