API Integration (Deprecated)

8min
Nexweave engage your audiences with interactive videos that can be personalized for millions!. We are introducing some API's endpoint which will help you to integrate Nexweave with your own platform.
Postman Collection 
Nexweave API's.postman_collection.json
﻿
﻿
List Template
This endpoint send you the response for the user's published templates.
URL: https://api.nexweave.com/api/v1/nexweave-integration/﻿template-listing﻿
Method: GET
Header: 
Authorization >  [API KEY]
Response:
GraphQL
JS

﻿
﻿
List Template variables
This endpoint returns the variables and their default value used in the template. Request body can be either template id or campaign id.
URL: https://api.nexweave.com/api/v1/nexweave-integration/﻿variable-listing﻿
Method: POST
Header: 
Authorization >  [API KEY]
Body:
JS
{
    "template_id": "9734567890ad0987cf654347" // Nexweave template ID
}
// OR
{
    "campaign_id": "8964567890ad0987cf64796" // Nexweave campaign ID
}

{
    "template_id": "9734567890ad0987cf654347" // Nexweave template ID
}
// OR
{
    "campaign_id": "8964567890ad0987cf64796" // Nexweave campaign ID
}
﻿
Response:
JS
[
    {
      "key": "USERNAME", // Variable key name
      "default": "Nexuser", // Variable's default value
      "required": true // Required key
    },
    {
      "key": "EMAIL",  // Variable key name
      "default": "[email protected]",  // Variable default value
      "required": true // Required key
    }
]
[
    {
      "key": "USERNAME", // Variable key name
      "default": "Nexuser", // Variable's default value
      "required": true // Required key
    },
    {
      "key": "EMAIL",  // Variable key name
      "default": "some-email@gmail.com",  // Variable default value
      "required": true // Required key
    }
]
﻿
﻿
List Campaign
This endpoint returns a list of campaign which you have already ran from the Nexweave platform.
URL: https://api.nexweave.com/api/v1/nexweave-integration/﻿campaign-listing﻿
Method: GET
Header: 
Authorization >  [API KEY]
Body: 
Response:
JS
{
    "key": "campaign_name", // name of the campaign
    "id": "8964567890ad0987cf64796" // campaign id
}
{
    "key": "campaign_name", // name of the campaign
    "id": "8964567890ad0987cf64796" // campaign id
}
﻿
﻿
Generate Experience URL
This endpoint generates a Nexweave experience link, thumbnail link, and image link based on the request body. If we pass "campaign_id" and data of variables in a request, then endpoint will generate experience_link, thumbnail_link and image_link which we have used while creating campaign. If we pass "template_id" with data of variables in request then endpoint will only return only experience_link.
URL: https://api.nexweave.com/api/v1/nexweave-integration/﻿﻿experience﻿﻿
Method: POST
Header: 
Authorization >  [API KEY]
Body:
JS
{
    "template_id": "9734567890ad0987cf654347", // Nexweave template ID
    "data": {  // Template variable data
        "USERNAME": "Nexuser",
        "EMAIL": "[email protected]"
    }
}
// OR
{
    "campaign_id": "8964567890ad0987cf64796" // Nexweave campaign ID
    "data": {  // Template variable data
        "USERNAME": "Nexuser",
        "EMAIL": "[email protected]"
    }
}
{
    "template_id": "9734567890ad0987cf654347", // Nexweave template ID
    "data": {  // Template variable data
        "USERNAME": "Nexuser",
        "EMAIL": "user@mail.com"
    }
}
// OR
{
    "campaign_id": "8964567890ad0987cf64796" // Nexweave campaign ID
    "data": {  // Template variable data
        "USERNAME": "Nexuser",
        "EMAIL": "user@mail.com"
    }
}
﻿
Response:
JS
{
    "video_link": "https://embed.nxwv.io/[ID]/[LINK_ALIAS]",
    "thumbnail_link": "https://staging-thumbnail.nxwv.io/v2/[ID]type=tt",
    "image_link": "https://staging-thumbnail.nxwv.io/v2/[ID]type=it"    
}
{
    "video_link": "https://embed.nxwv.io/[ID]/[LINK_ALIAS]",
    "thumbnail_link": "https://staging-thumbnail.nxwv.io/v2/[ID]type=tt",
    "image_link": "https://staging-thumbnail.nxwv.io/v2/[ID]type=it"    
}
﻿
﻿
﻿
Updated 25 Mar 2024
Did this page help you?
Nexweave API
COLD OUTREACH
Docs powered by Archbee
TABLE OF CONTENTS
List Template
List Template variables
List Campaign
Generate Experience URL