API & SDK
Nexweave API

44min
Nexweave engages your audiences with interactive videos that can be personalized for millions!. Using Nexweave API, the process of generating the Nexweave experience for both images and videos can be automated.
﻿
DOWNLOAD POSTMAN COLLECTION
Nexweave API
﻿
﻿
﻿
WORKFLOW
﻿
﻿
     User's Workflow
Users will view all the Nexweave Campaigns or Templates for which a Nexweave experience (Video/Image/Video + Image) needs to be created.
The user selects one of the Campaign/Template created on the Nexweave platform.
Users will view all the variables required for creating the Nexweave experience for a particular campaign or template and will enter the values for them.
Based on the user's input, the Nexweave experience will be generated.
     Automation Workflow
Below would be the automation workflow for creating the Nexweave experience on the fly.
The user configures the campaign/template for which the experience needs to be generated by entering the Template ID or Campaign ID.
All the variables associated with the configured Campaign/Template will be populated based on the Datasource the user has selected.
Based on the data, the Nexweave experience will be generated and forwarded using any of the delivery platforms like Email, Chatbot, Push-Notification, Linkedin automation etc.
﻿
CAMPAIGNS
﻿
Get All Campaigns
 This API will return all the CSV Campaigns associated with the user's account, including Images, Videos &  Image+Video Campaign.
Note: The campaigns must be in Success state.
URL: https://api.nexweave.com/api/v1/integration/campaign﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "IMG"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO"
    }
]    
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "IMG"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO"
    }
]    
﻿
﻿
﻿
Get Image Campaigns
  This API will return all the image campaigns associated with the user's account.
URL: https://api.nexweave.com/api/v1/integration/campaign?experience_type=image﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "IMG"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "IMG"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "IMG"
    }
]    
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "IMG"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "IMG"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "IMG"
    }
]    
﻿
﻿
﻿
Get Video Campaigns
  This API will return all the video campaigns associated with the user's account.
URL: https://api.nexweave.com/api/v1/integration/campaign?experience_type=video﻿
﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "VIDEO"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO"
    }
]    
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "VIDEO"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO"
    }
]    
﻿
﻿
﻿
Get Image + Video Campaigns
  This API will return all the image + video campaigns associated with the user's account, where the image is linked to a video experience on a landing page
URL: https://api.nexweave.com/api/v1/integration/campaign?experience_type=video_and_image﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO_AND_IMAGE"
    }
]    
[
    {
        "name": "Campaign 1",
        "id": "5fe35ba9bd6812125a743974",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 2",
        "id": "5fe356ddbd6812125a743922",
        "type": "VIDEO_AND_IMAGE"
    },
    {
        "name": "Campaign 3",
        "id": "5fe32a9d54ad05126f84fa55",
        "type": "VIDEO_AND_IMAGE"
    }
]    
﻿
﻿
﻿
Get Campaign Details
  This API will return the Campaign details including variables used in the overall Campaign.
URL: https://api.nexweave.com/api/v1/integration/campaign/{{campaignId}}﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
{
    "result": {
        "variables": [
            {
                "key": "USERNAME",
                "default": "Nexweaver"
            }
        ]
    }
}
{
    "result": {
        "variables": [
            {
                "key": "USERNAME",
                "default": "Nexweaver"
            }
        ]
    }
}
﻿
﻿
﻿
Create Campaign Experience
  This API will generate one or more experiences depending on the templates used in the campaign. If the campaign is Image only campaign, then the only image_link will be generated. If the Campaign has a video as well as the thumbnail for the video, then video_link & thumbnail_link will be generated too. 
URL: https://api.nexweave.com/api/v1/nexweave-integration/experience﻿
Method: POST
Header: 
                  X-API-KEY:  API-KEY 
Body
JSON
|
{
   "campaign_id": "5fb24900c044b60f4a8758c1",
   "data": { 
       "USERNAME": "Nexweaver"
   }
}

{
   "campaign_id": "5fb24900c044b60f4a8758c1",
   "data": { 
       "USERNAME": "Nexweaver"
   }
}
﻿
﻿
Response: 
JSON
|
{
    "video_link": "https://videos.indusved.com?nexid=T8trfwv-i",
    "thumbnail_link": "https://images.indusved.com/T8trfwv-i?type=tt",
    "image_link": "https://images.indusved.com/T8trfwv-i?type=it"
}
{
    "video_link": "https://videos.indusved.com?nexid=T8trfwv-i",
    "thumbnail_link": "https://images.indusved.com/T8trfwv-i?type=tt",
    "image_link": "https://images.indusved.com/T8trfwv-i?type=it"
}
﻿
﻿
Note: videos.indusved.com & images.indusved.com are custom domains that have been attached to the image and video links.
﻿
﻿
TEMPLATES
﻿
Get All Templates
  This API will return all the templates associated with the user's account, including Images & Video.
URL: https://api.nexweave.com/api/v1/integration/template﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
﻿
﻿
﻿
Get Image Templates
  This API will return all the image templates associated to the user's account.
URL: https://api.nexweave.com/api/v1/integration/template?template_type=image﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
﻿
﻿
﻿
Get Video Templates
  This API will return all the video templates associated with the user's account.
URL: https://api.nexweave.com/api/v1/integration/template?template_type=video﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
[
    {
        "name": "New User Onboarding",
        "id": "5ff0ad741fc9fd7e3121a8f2",
        "type": "VIDEO"
    },
    {
        "name": "New Year Greeting",
        "id": "5ud53900a539f924cd73ed7a",
        "type": "VIDEO"
    }
]    
﻿
﻿
﻿
Get Template Details
  This API will return the template details including variables for a valid template.
URL: https://api.nexweave.com/api/v1/integration/template/{{templateId}}﻿
Method: GET
Header: 
                  X-API-KEY:  API-KEY 
Response:
JSON
|
{
    "result": {
        "variables": [
            {
                "key": "USERNAME",
                "default": "Nexweaver"
            },
            {
                "key": "CTA_1",
                "default": "https://www.nexweave.com"
            }
        ]
    }
}
{
    "result": {
        "variables": [
            {
                "key": "USERNAME",
                "default": "Nexweaver"
            },
            {
                "key": "CTA_1",
                "default": "https://www.nexweave.com"
            }
        ]
    }
}
﻿
﻿
﻿
Create Template Experience
  This API will generate an Image or Video experience depending on the Template.
URL: https://api.nexweave.com/api/v1/nexweave-integration/experience﻿
Method: POST
Header: 
                  X-API-KEY:  API-KEY 
Body
JSON
|
{
   "template_id": "5fb24900c044b60f4a8758c1",
   "data": { 
       "USERNAME": "Nexweaver"
   }
}

{
   "template_id": "5fb24900c044b60f4a8758c1",
   "data": { 
       "USERNAME": "Nexweaver"
   }
}
﻿
﻿
Response: 
For Video Template, the JSON response will have video_link as output.
JSON
|
{
    "video_link": "https://videos.indusved.com/P66UW3OKU/Thank_you_Nexweaver"
}
{
    "video_link": "https://videos.indusved.com/P66UW3OKU/Thank_you_Nexweaver"
}
﻿
﻿
For Image Template, the JSON response will have image_link as output.
JSON
|
{
    "image_link": "https://images.indusved.com/NmRuTVpn8?type=it"
}
{
    "image_link": "https://images.indusved.com/NmRuTVpn8?type=it"
}
﻿
﻿
Note: 
﻿For every experience created using the Template, a Quick Campaign will be created to the corresponding user's account.﻿
videos.indusved.com & images.indusved.com are custom domains that have been attached to the image and video links.
﻿