{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"504cf0c6-8cd8-4079-a277-31cfdcf6d363","name":"CATALOGPLAYER API REST","description":"### **Introduction**\n\nThe CatalogPlayer API, also known as the Internal API, incorporates features of both REST API and BULK API, enabling bulk uploads or mass queries.\n\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns responses in JSON or CSV format, and uses standard HTTP response codes.\n\nYou will need a CatalogPlayer account with web service permissions and a user with valid credentials to generate a valid session and connect to the API.\n\nWe recommend using this API to retrieve or send real-time data. However, if you need to handle bulk data, you will need to use our CGC API following the specifications of our CPObjects entities.\n\nAll API requests must be made over HTTPS to the domain of your CatalogPlayer account, e.g., [https://1234XXX.mycpl.net](https://1234XXX.mycpl.net). Calls made over unsecured HTTP are likely to fail, and API requests without authentication will also fail.\n\nThis document is a concise guide that includes examples of some available methods within the API.\n\n### Authentication\n\nThe CatalogPlayer API uses API keys to authenticate requests. You can view and manage your API keys through your backend. Using your API key (SSID), you must generate a valid session and obtain all credentials for the API.\n\nTo locate your SSID, log in as a superadministrator in the backend, navigate to your account section, and look for the API section.\n\nTo view or generate user sessions, go to the “Users / API” section. Each API user and hash can have configurable permissions and access through the ACL permissions management system.\n\n**IMPORTANT:** Deleting or regenerating the admin user’s hash may result in losing all communications with the primary connectors. Use a different user/license to activate another hash.\n\nGetting Started\n\n**Generate a New HASH via API**\n\nThe hash can be generated either via the API or directly through the backend. If the session (HASH) is generated through the backend, it does not expire and can be used for all your requests.\n\nTo make calls to the web service, you must first obtain a hash, which will be used for all requests along with the SSID.\n\nTo do this, you need to call the **Get Credentials API** method:\n\nhttp://{{domain}}/api.php/api/v1/user/login?ssid={{ssid}}\n\n```\n             - domain is you account domain\n             - ssid from user webservice\n\n ```\n\nRequired Paramenters:\n\n```\n             -user name\n             -password\n\n ```\n\n**This will return a JSON** containing the same SSID you sent and the hash required for subsequent requests.\n\nThe generated hash does not expire unless it remains unused for 90 days.\n\n{\n\n\"code\": 200,\n\n\"message\": \"DATA_OK\",\n\n\"data\": {\n\n```\n   \"consumer\": \"48b4fef01a1ed699db5FFFFFFb816b4781\",\n   \"hash\": \"d5c39c7fb79fa02dFGDFGGHF1bec8a4\"\n\n ```\n\n}\n\n}\n\n### **Making Requests**\n\n**General Features and Parameters**\n\nRequests for querying data can be made using **POST** , while requests for inserting data must be made using **POST**.\n\nAll requests should be directed to the environment URL in the following format:\n\nhttps://{{domain}}/api.php/api/v1/\n\nThe variables and parameters remain consistent, with the following options:\n\n• **domain**: The environment URL.\n\n• **ssid**: Obtainable from the backend or **CPAdmin** (client details section).\n\n• **hash**: Retrieved via the **Get Credentials** method, through the backend or **CPAdmin** (client details section).\n\n• **limit** _(optional)_: Specifies the maximum number of records to retrieve. The default value is 200. To set higher limits and return more records per page, you may need to contact your assigned Partner or CatalogPlayer to confirm feasibility.\n\n• **offset** _(optional)_: Used for pagination of records.\n\n**Filters**\n\nFilters can be applied to queries using the following options:\n\n• **operator**: Defines the filter operation. Possible values include:\n\n\\>, >=, <, <=, IN, NOT IN, LIKE, =, !=\n\n**Filter Examples:**\n\n1\\. **Equality (**\\=**)**:\n\n\\[{\"operator\":\"=\", \"value\":\"00001\", \"field_name\":\"Token\"}\\]\n\n2\\. **IN or NOT IN**:\n\n\\[{\"operator\":\"IN\", \"value\":\\[\"CP6\", \"CP3\"\\], \"field_name\":\"Status\"}\\]\n\n3\\. **LIKE or NOT LIKE**:\n\n\\[{\"operator\":\"LIKE\", \"value\":\"%2017-02-07%\", \"field_name\":\"DateAt\"}\\]\n\n**Filter Fields**\n\n• **field_name**: The field to filter on, e.g., CompanyToken.\n\n• **value**: The value to filter by. Acceptable types include string, integer, long, datetime, or date.\n\n### Examples\n\nBelow are examples of requests for querying and managing data.\n\nIn this example, we retrieve a client of type “PROSPECT”:\n\n```\nhttp://{{domain}}/api.php/api/v1/company/get?ssid={{ssid}}\nParametros:\n- hash : {{hash}}\n- limit(optional): 1\n- filters: [{\"operator\":\"=\", \"value\":\"PROSPECTO\",\"field_name\":\"CompanyTypeToken\"}]\n\n ```\n\nThis query returns clients classified as “Prospects”. Additional filters can be added as needed.\n\nFor instance, you can retrieve all prospects created on a specific date.\n\n**List Client Supplemental Data (Forms)**\n\nRetrieve additional information stored in a client’s profile using **GetFormResponses**:\n\nhttp://{{domain}}/api.php/api/v1/company/GetFormResponses?ssid={{ssid}}\n\n**Parameters:**\n\n• hash: {{hash}}\n\n• ssid: {{ssid}}\n\n• **Filters**:\n\n• Token (Client code).\n\n• UpdatedAt (Forms updated on a specific date).\n\n• FormToken (Filter by form type).\n\n• CreatedAt (Forms created on a specific date).\n\n**Example Filter**:\n\n\\[{\"operator\":\"=\", \"value\":\"00001\", \"field_name\":\"Token\"}\\]\n\n```\nhttp://{{domain}}/api.php/api/v1/company/GetFormResponses?ssid={{ssid}}</nowiki>\n-        hash : {{hash}}\n-        ssid : ={{ssid}}\n-        Filtros\no    Token (codigo empresa),\no     'UpdatedAt' ( modified forms )\no     'FormToken' ( Filter by type of form)\no    'CreatedAt' ( Created Forms )\nIn this example, we can extract additional information reported in a form linked to a customer using GetFormResponses\n        - filters: [{\"operator\":\"=\", \"value\":\"00001\",\"field_name\":\"Token\"}]\n                          \"operator\": \">, >=, <, <=, IN, NOT IN, LIKE, =, !=\"\n                           \"value\":\"string, integer, long, datetime, date\",\n                           \"field_name\":\n                          \"Token\": String\n       \"responses\": {\n                   \"CP56\": [\n                       [\n                           {\n                               \"Token\": \"CSH_1537949766727\",\n                               \"CreatedAt\": \"2018-09-26 10:15:39\",\n                               \"UserToken\": \"000066\",\n                               \"User\": \"Javier Bueno\",\n                               \"Geoposition\": \"41.6009512,2.2778165\",\n                               \"CompanyToken\": \"Company_1537949727235\",\n                               \"Company\": \"Alberto Albertez\",\n                               \"FormToken\": \"CP56\",\n                               \"Form\": \"Perfil Prospecto\",\n                               \"Department_1\": \"CP1\",\n                               \"Department_2\": \"Dirección Filial GC\",\n                               \"Department_3\": \"CP254\",\n                               \"Department_4\": \"Zona NorEste GC\",\n                               \"Department_5\": \"Zona NorOeste GC\",\n                               \"Department_6\": \"Zona Sur GC\",\n                               \"Department_7\": \"Portugal GC\",\n                               \"Department_8\": \"Zona Portugal GC\",\n                               \"Department_9\": \"TareasGlobales\",\n                               \"Department_10\": \"Mexico GC\",\n                               \"Department_11\": \"Zona Mexico GC\",\n                               \"CP56-Familias\": \"\",\n                               \"CP56-Maíz\": \"\",\n                               \"CP56-Girasol\": \"\",\n                               \"CP56-Forrajeras\": \"\",\n                               \"CP56-Cereales\": \"Cereales\",\n                               \"CP56-Calificación\": \"Tipo C\",\n                               \"CP56-Semillas\": \"\",\n                               \"CP56-Seminis\": \"40%\",\n                               \"CP56-Gautier\": \"30%\",\n                               \"CP56-Pioneer\": \"10%\",\n                               \"CP56-Curimapu\": \"20%\",\n                               \"CP56-Notas\": \"\",\n                               \"CP56-Comentarios\": \"Test\"\n                           }\n                       ]\n                   ]\n               }\n\n ```\n\n**\n\nList Tasks**\n\nRetrieve tasks for a specific date (e.g., February 7, 2017):\n\nhttp://{{domain}}/api.php/api/v1/task/get?ssid={{ssid}}\n\n**Parameters:**\n\n• hash: {{hash}}\n\n• limit (optional).\n\n• filters:\n\n\\[{\"operator\":\"LIKE\", \"value\":\"%2017-02-07%\", \"field_name\":\"DateAt\"}\\]\n\n```\nhttp://{{domain}}/api.php/api/v1/task/get?ssid={{ssid}}\n                 - hash : {{hash}}\n                 - limit(opcional)\n                 - filters: [{\"operator\":\"LIKE\", \"value\":\"%2017-02-07%\",\"field_name\":\"DateAt\"}]\n\n ```\n\n**Edit Client Information**\n\nModify a client’s information (e.g., update the client code):\n\nhttp://{{domain}}/api.php/api/v1/company/set?ssid={{ssid}}\n\n**Parameters:**\n\n• hash: {{hash}}\n\n• filters:\n\n\\[{\"operator\":\"=\", \"value\":\"00001\", \"field_name\":\"Token\"}\\]\n\n• fields:\n\n\\[{\"field\":\"code\", \"value\":\"00001\"}\\]\n\n**Accepted Fields:**\n\n• Active (Boolean).\n\n• Token (String).\n\n• ExternalToken (String).\n\n• Code (String).\n\n```\nhttp://{{domain}}/api.php/api/v1/company/set?ssid={{ssid}}\n                 - hash : {{hash}}\n                 - filters: [{\"operator\":\"=\", \"value\":\"00001\",\"field_name\":\"Token\"}]\n                                   \"operator\": \">, >=, <, <=, IN, NOT IN, LIKE, =, !=\"\n                                    \"value\":\"string, integer, long, datetime, date\",\n                                    \"field_name\":\n                                   \"Token\": String\n                 - fields: [{\"field\":\"code\",\"value\":\"00001\"}]\n                                   Fields aceptados:\n                                                    \"Active\": Boolean,\n                                                    \"Token\": String,\n                                                    \"ExternalToken\": String,\n'''                                                   ''' \"Code\": String\n                                   \"operator\": \">, >=, <, <=, IN, NOT IN, LIKE, =, !=\"\n                                    \"value\":\"string, integer, long, datetime, date\",\n                                    \"field_name\":\n                                                    \"Token\": String\n                                                    \"DateAt\": Datetime\n                                                    \"Status\": String\n                                                    \"Name\": String\n                                                    \"Description\": String\n                                                    \"UserToken\": String\n                                                    \"CompanyToken\": String\n                                                    \"FormToken\": String\n\n ```\n\n**Convert a Prospect to a Client**\n\nUpdate a client of type “Prospect” to “Client”:\n\nhttp://{{domain}}/api.php/api/v1/company/setProspectToClient?ssid={{ssid}}\n\n**Parameters:**\n\n• hash: {{hash}}\n\n• filters:\n\n\\[{\"operator\":\"=\", \"value\":\"CP2\", \"field_name\":\"CompanyTypeToken\"}\\]\n\n• fields:\n\n\\[{\"field\":\"Token\", \"value\":\"CP0002\"}\\]\n\n**Accepted Fields:**\n\n• Active (Boolean).\n\n• Token (String).\n\n• ExternalToken (String).\n\n```\nhttp://{{domain}}/api.php/api/v1/company/setProspectToClient?ssid={{ssid}}\n                 - hash : {{hash}}\n                 - filters: [{\"operator\":\"=\", \"value\":\"CP2\",\"field_name\":\"CompanyTypeToken\"}]\n                                   \"operator\": \">, >=, <, <=, IN, NOT IN, LIKE, =, !=\"\n                                    \"value\":\"string, integer, long, datetime, date\",\n                                    \"field_name\":\n                                                    \"Token\": String\n                                                    \"CompanyTypeToken\": String\n                                   - fields: [{\"field\":\"Token\",\"value\":\"CP0002\"}]\n                                                    Fields aceptados:\n                                                                      \"Active\": Boolean,\n                                                                      \"Token\": String,\n                                                                      \"ExternalToken\": String,\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32826335","team":6024844,"collectionId":"504cf0c6-8cd8-4079-a277-31cfdcf6d363","publishedId":"2sA2xk1riu","public":true,"publicUrl":"https://developers.catalogplayer.com","privateUrl":"https://go.postman.co/documentation/32826335-504cf0c6-8cd8-4079-a277-31cfdcf6d363","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00A199"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"CATALOGPLAYER REST API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/bb48b678-bbb1-498d-8904-7816e2debd97/bG9nb19jcC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"00A199"}},{"name":"light","logo":"https://content.pstmn.io/bb48b678-bbb1-498d-8904-7816e2debd97/bG9nb19jcC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00A199"}}]}},"version":"8.10.1","publishDate":"2024-03-13T21:42:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"CATALOGPLAYER REST API","description":""},"logos":{"logoLight":"https://content.pstmn.io/bb48b678-bbb1-498d-8904-7816e2debd97/bG9nb19jcC5wbmc=","logoDark":"https://content.pstmn.io/bb48b678-bbb1-498d-8904-7816e2debd97/bG9nb19jcC5wbmc="}},"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/7f0ee1aba73d282d3e933f2eaa3c09a396d1ff5ed60572009bf2fb221c30d6e6","favicon":"https://catalogplayer.com/favicon.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"}],"canonicalUrl":"https://developers.catalogplayer.com/view/metadata/2sA2xk1riu"}