MDP Script APIs

The following set of APIs pertains to the Script aspect of the Online Store on Instamojo.

Scopes (for the access token that is used) required to run the JS APIs:

script-values:write
script-values:read

Error codes and their meanings :

How to get Variable ID:

Please drop a mail to [email protected] with your App name and the Email ID with which you have signed up on developers.instamojo.com to obtain the variable ID for your App.

How to add Script:

You can use Add Script to inject any custom script on all subscribed merchant's stores.

How to add a custom script -

1. Select a Page Type
   1. You have to select a page type where you want to run the custom script.
   2. Below are the different page types
      • Product page - The script will be applied to all the product pages.
      • Category page - The script will be applied to all the category pages.
      • Custom page - The script will be applied to all the custom pages created by the merchant.
      • Store pages (Home, About Us, FAQ, etc) - The script will be applied to all the default pages.
      • Store Wide (All) - The script will be applied to all store pages.
2. Template
   1. Write/Paste your custom script to the template.
   2. If you wish to get merchants (subscriber) input in your custom script then use as a variable and that should be provided in curly braces, so in the below example {name} is the variable. We again have to declare this in the Add Variable.

3. Add a variable
   1. Title - Title of the variable.
   2. Key - This is the variable, use the same as we used in the script in curly braces, for example - name.
      1. Note - If you have space in name then use underscore as key, for ex - google_id and the same should be used in curly braces in the template {google_id}
   3. Description - This will help in the merchant experience.
   4. Note – You can skip Add Variable flow if you don't want any merchant inputs.

4. Once submitted, if you have provided a Redirect URL, the permission page will be shown as below, where you need to add the Script Values permission. If a Redirect URL is not provided, the permission page will not be shown.

Merchant Experience:

Once the App is LIVE on our App store, a merchant can use the app by selecting it and clicking on the Subscribe button.

You must know the below possible scenario

Image 1

Image 2

Image 3

How to Use the API Endpoint -

The given endpoints are used to fetch and update the script variable. In order to use the scriptValue API first you can trigger the Authorization API and fetch the access token to run the below-given endpoints.

Below are the required scopes for running the following endpoints are:

script-values:write

script-values:read

GET API

Url:- https://api.instamojo.com/v2/store/scriptvalues/<app_id>

Method:- GET

Response:-

{
      "version": 1,
      "title": "Alert Script",
      "description": "Your Name",
      "template": "<script>alert('Hi {name}, How are you'));</script>",
      "section": 1,
      "tags": [
    "google",
    "analytics",
    "seo"
  ],
      "page_type": 5,
      "app_status": "pending",
      "values": [
            {
                  "id": 1A,
                  "key": "name",
                  "title": "Name",
                  "description": "Your Name",
                  "value": "",
                  "variable_id": 1B,
              
    }    
  ]
}

Update API

Url:- https://api.instamojo.com/v2/store/scriptvalues/<app_id>

Method:- PATCH

Payload:-

1. To add new value use the below payload -
   json

   {
     "values": [
             {
                   "variable_id": 1B,
                   "value": "Tarun"           
       }
     ]
   }
   

2. To update existing value use the below payload -
   json

   {
     "values": [
             {
                   "id": 1A,
                   "value": "Bhorhari"           
       }
     ]
   }
   

3. To delete use the below payload -
   json

   {
     "values": [
             {
                   "id": 1A,
                   "is_active": False
       }
     ]
   }
   

Response

{
      "version": 1,
      "title": "Alert",
      "description": "Your Name",
      "template": "<script>alert('Hi {name}, How are you'));</script>",
      "section": 1,
      "tags": [
    "google",
    "analytics",
    "seo"
  ],
      "page_type": 5,
      "app_status": "pending",
      "values": [
           {
                  "id": 1A,
                  "key": "name",
                  "title": "Name",
                  "description": "Your Name",
                  "value": "",
                  "variable_id": 1B,
              
    }   
  ]
}