{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"63fe21cb-16ad-4513-ab2a-96424fc7685b","name":"XMPie Video Service API","description":"The XMPie Video Service (XVS) API can be used to programmatically create personalized videos.\r\nThis documentation includes a Postman collection that will help you create a personalized video, which can be generated upon a user request. \r\n\r\nYou can download the collection with its environment variables by clicking the \"Run in Postman\" button at the top right corner of the screen. This Postman collection was created in version 7.34.0.\r\n\r\n## Authentication\r\nXVS supports OAuth 2.0 for authorizing API requests. Authorized requests to the API should use an Authorization header with the value of a token, where the token is a token obtained through the [OAuth](https://api-docs.xmpvs.com/#c1e7f0d2-c417-47b3-b38e-cd963354bdf9) call.\r\n\r\n## Environment variables\r\nThe following are the XVS API environment variables:\r\n\r\n1. apiBaseUrl - the XVS API base URL (https://api-eu.xmpvs.com).\r\n2. username - the XVS username.\r\n3. password - the XVS password.\r\n4. token - the ID token that is returned in the OAuth flow of the [Login - Get Token](https://api-docs.xmpvs.com/#c1e7f0d2-c417-47b3-b38e-cd963354bdf9) request.\r\n5. refreshToken - the refresh token value that is returned in the OAuth flow of the [Login - Get Token](https://api-docs.xmpvs.com/#9f122a8e-f907-4b6c-b159-30ab1c7a8c11) request.\r\n6. assetUploadUrl - the signed URL received from the [Get Assets Upload Url](https://api-docs.xmpvs.com/#b6e1d279-6720-48f1-9e44-5d9809f9cde3) request, with which it is possible to upload the asset to the XVS.\r\n7. dataSourceUploadUrl - the signed URL received from the [Get Data Source Upload Url](https://api-docs.xmpvs.com/#d1aa6005-532c-46f3-8e40-8d38cbe81c23) request, with which it is possible to upload the data source to the XVS.\r\n8. projectId - the project ID.\r\n9. recordId - the record ID.\r\n\r\n#### Edit environment variables\r\nFor OAuth flows (login or refresh token), enter the username and password variable values.\r\n\r\nTo define environment variables:\r\n1. In the top right corner of Postman, from the dropdown select the \"XVS API Variables\" environment, and then click the Environment quick look (eye button).\r\n2. Click Edit next to XVS API Variables. \r\n3. In the Manage Environments dialog box, enter a value for the username, password and projectId variables in the \"Current Value\" column.\r\n4. Click the Update button.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13626006","team":1408644,"collectionId":"63fe21cb-16ad-4513-ab2a-96424fc7685b","publishedId":"TVmMfcaW","public":true,"publicUrl":"https://api-docs.xmpvs.com","privateUrl":"https://go.postman.co/documentation/13626006-63fe21cb-16ad-4513-ab2a-96424fc7685b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-12-07T09:19:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"XVS API Variables","id":"acd00385-000b-4cee-86f8-8120da9c49ba","owner":"13626006","values":[{"key":"apiBaseUrl","value":"https://api-eu.xmpvs.com/v1","enabled":true},{"key":"refreshToken","value":"refresh_token","enabled":true},{"key":"username","value":"xvs_username","enabled":true},{"key":"projectId","value":"project_id","enabled":true},{"key":"assetUploadUrl","value":"asset_upload_url","enabled":true},{"key":"token","value":"token","enabled":true},{"key":"password","value":"xvs_password","enabled":true},{"key":"recordId","value":"record_id","enabled":true},{"key":"dataSourceUploadUrl","value":"data_source_upload_url","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c4e6685878cf6c1b63bad86c62dae8f5b2180b666caea6210ec6233b1ccda11f","favicon":"https://res.cloudinary.com/postman/image/upload/v1606984187/team/rvuhh8qcpe1iew8fwz4p.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"XVS API Variables","value":"13626006-acd00385-000b-4cee-86f8-8120da9c49ba"}],"canonicalUrl":"https://api-docs.xmpvs.com/view/metadata/TVmMfcaW"}