{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"201f0b5a-a68a-4e5c-b283-30169596e1a2","name":"Vodlix Documentation","description":"# Introduction\n\nWelcome to the Vodlix API documentation. Vodlix is a comprehensive OTT middleware solution designed to deliver a wide range of media services, including TV, Video On Demand (VOD), Catchup, DVR, and interactive services to customers across various networks.\n\nOur API allows you to create your own branded, white-labeled, multiscreen live and on-demand content streaming OTT and VOD platform like Netflix, Amazon Prime, Disney+, Hotstar.\n\nThis API documentation is your roadmap to successfully integrating and leveraging the Vodlix API. It provides detailed information on crucial aspects such as authentication, error codes, rate limits, and much more. Whether you're embarking on a new integration project or troubleshooting an existing one, this guide is your comprehensive resource for understanding and maximizing the potential of the Vodlix API.\n\nWe look forward to seeing the innovative platforms you'll create with Vodlix!\n\n# Overview\n\nThe Vodlix API is a powerful tool designed to provide developers with the ability to integrate and interact with the Vodlix platform. This API is built to offer a wide range of functionalities, from managing user accounts and content libraries, to controlling playback and handling subscriptions.\n\nThe API is RESTful, meaning it uses standard HTTP methods like GET, POST, PUT, and DELETE. It returns data in JSON format, making it easy to integrate with a variety of programming languages and platforms.\n\n# Authentication\n\nIn our Vodlix API, we have implemented a cookie-based authentication system to ensure secure user sessions. Upon a user's successful login, a unique session is initiated on the server-side, and a corresponding cookie is dispatched to the client's device.\n\nThis cookie encapsulates a unique session ID, which serves as a persistent identifier for the user throughout their session. Each subsequent request from the client includes this session ID, allowing the server to validate the user's identity by cross-referencing the session ID with the active sessions on the server-side.\n\nThis approach enables us to maintain stateful sessions between the client and the server, ensuring a secure and seamless user experience. It provides a robust mechanism to verify user identity across multiple requests, thereby enhancing the security and integrity of user interactions with our platform.\n\nFor a more detailed explanation and a step-by-step guide on how to log in with the API, please refer to our [Authorization Section](https://documenter.getpostman.com/view/6478073/2s946ffYtT#authorization).\n\n# Error Codes\n\nThe error codes you may encounter will vary depending on the specific API endpoint. However, here are some common HTTP status codes you might come across:\n\n- **200 OK**: The request was successful.\n    \n- **400 Bad Request**: The server could not understand the request due to invalid syntax.\n    \n- **401 Unauthorized**: The request requires user authentication.\n    \n- **403 Forbidden**: The server understood the request, but it refuses to authorize it.\n    \n- **404 Not Found**: The server can't find the requested resource.\n    \n- **500 Internal Server Error**: The server has encountered a situation it doesn't know how to handle.\n    \n\n# Rate limit\n\nRate limiting is a technique for limiting network traffic. It sets a limit on how many requests a client can make to an API within a certain time period. The specific limit would depend on the API's policy. If a client exceeds this limit, the server will typically respond with a 429 Too Many Requests HTTP status code.\n\n# Authorization\n\nOur authorization process is based on cookies. When a user logs in, we send back three key pieces of information in the response: `phpid`, `sess_salt`, and `token`. These values are stored in cookies and must be included in subsequent requests to authenticate the user.\n\nIf you're using a cloud setup, the cookies will have a prefix of `{cloud_name}`. So, for example, if your cloud name is \"mycloud\", the cookies would be named `mycloudphpid`, `mycloudsesssalt`, and `mycloudtoken`.\n\nIf you're not using a cloud setup the cookies will have standard names: `phpid, sesssalt, token`\n\nTo ensure that you're correctly implementing the login process using our API, we've created a step-by-step tutorial video. You can watch it [here](https://youtu.be/riqKaNZ_e5A) to learn how to properly use the API for login in Postman.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6478073","team":1571307,"collectionId":"201f0b5a-a68a-4e5c-b283-30169596e1a2","publishedId":"2s946ffYtT","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6478073/2s946ffYtT","privateUrl":"https://go.postman.co/documentation/6478073-201f0b5a-a68a-4e5c-b283-30169596e1a2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"e74f51"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Vodlix API Documentation"},{"name":"title","value":"Vodlix API Documentation"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/5a57de45-3f79-45f2-b7b5-b96c71550f17/dm9kbGl4X2RhcmsucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"e74f51"}},{"name":"light","logo":"https://content.pstmn.io/e04648d8-7b2c-4123-83b3-54e797c01289/dm9kbGl4X2xvZ28ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"e74f51"}}]}},"version":"8.10.1","publishDate":"2025-06-16T12:29:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Vodlix API Documentation","description":"Vodlix API Documentation"},"logos":{"logoLight":"https://content.pstmn.io/e04648d8-7b2c-4123-83b3-54e797c01289/dm9kbGl4X2xvZ28ucG5n","logoDark":"https://content.pstmn.io/5a57de45-3f79-45f2-b7b5-b96c71550f17/dm9kbGl4X2RhcmsucG5n"}},"statusCode":200},"environments":[],"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/0520ecb74eb9f1f7b00cf5faa0e606ebf8b69d044ef54692753cef4d5fe98c9f","favicon":""},"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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s946ffYtT"}