{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"72665720-38be-adfc-c645-15d8af020e52","name":"API - VIPCommerce","description":"A API VIP Commerce permite a criação, gerenciamento e consulta de diversas funcionalidades do sistema.\n\nA API pode ser consumida por sistemas externos como CRMs (\"Costumer Relationship Management\", ou \"Gestão de Relacionamento com o Cliente\"). \n
\nO acesso se dá mediante um token que deve ser gerado através da aplicação do lojista.\n\n# Cabeçalho\nDescrição do cabeçalho ``headers`` da requisição.\n\n|Propriedade|Descrição|Obrigatório|\n|-----------|---------|-----------|\n|Accept|Informa o servidor sobre o tipo de dado que será retornado.
**Atenção** o tipo de retorno permitido é `json`. Conforme o exemplo: `Accept: application/json` |Sim|\n|Authorization|Token de acesso de tipo “Basic” com base64 do usuário e senha (username:password). O token é uma chave de identificação do usuário servindo para um único domínio.
Atenção quando não informado corretamente ou inexistente a utilização da API é recusada, retornando o código de status 401 Unauthorized.|Sim|\n|DomainKey|Identificador do domínio. Permite identificar o domínio de destino da requisição. Conforme o exemplo: `DomainKey: vipcommerce.com.br`. **Atenção** não informando esta propriedade ou informando incorretamente será retornado o código de status `500 Internal Server Error`, com a mensagem \"DomainKey is not defined\"|Não. Deverá ser enviado o DomainKey ou OrganizationID|\n|OrganizationID|Número identificador da organização. Permite identificar a organização de destino da requisição. Conforme o exemplo: `OrganizationID: 1`.|Não. Deverá ser enviado o DomainKey ou OrganizationID |\n\n

✖ ERROS ✖

\n\n
➤ Campo Accept do cabeçalho não enviado
\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O Cabeçalho Accept deve ser incluído na requisição\", quando o campo Accept do cabeçalho não for enviado na requisição, conforme o exemplo abaixo.\n\n```\n{\n \"success\": false,\n \"code\": 422,\n \"message\": \"O Cabeçalho Accept deve ser incluído na requisição'\"\n}\n```\n
➤ Campo DomainKey do cabeçalho não enviado
\n\nSerá retornado o código de status 500 Internal Server Error com a mensagem \"DomainKey is not defined\", quando o campo DomainKey do cabeçalho não for enviado na requisição, conforme o exemplo abaixo.\n\n```\n{\n \"success\": false,\n \"data\": {\n \"message\": \"Ocorreu um erro interno.\",\n \"url\": \"/importacao/clientes?created_inicial=2020-06-23&created_final=2020-12-23\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"Cake\\\\Core\\\\Exception\\\\Exception\",\n \"code\": 500,\n \"message\": \"DomainKey is not defined\"\n }\n }\n}\n```\n

Token de acesso

\nPara efetuar chamadas para as APIs do VipCommerce é necessário se autenticar através do token informado no header. O token é gerado com base64 do usuário e senha (username:password). \n
Suponhamos que seu usuário seja: vipcommerce@teste.com.br e sua chave de acesso seja: 673ab009bd2b611816415a3ab2f9b2ffbede60b28c90512991a1addcc7fa216c\n
O token de acesso gerado será: dmlwY29tbWVyY2VAdGVzdGUuY29tLmJyOjY3M2FiMDA5YmQyYjYxMTgxNjQxNWEzYWIyZjliMmZmYmVkZTYwYjI4YzkwNTEyOTkxYTFhZGRjYzdmYTIxNmM=\n\n

Permisão de acesso da API

\nA API permite conceder ou revorgar permissões dos usuários, caso retornado o código de status 403 Forbidden com a mensagem: \"Você não está autorizado a acessar esse local.\". Verifique se o seu usuário está habilitado a utilizar esta ação na API.
Acesse: Configurações -> Funcionários e Permissões -> Usuários da API. Clique no cadeado do seu usuário e habilite a ação no modulo desejado.\n\n# Sandbox\n\nPara facilitar a utilização da API de ofertas do VIP Commerce, disponibilizamos um ambiente para realização de testes.\n\n## Requisição\n\nPara utilizar o Sandbox é necessário configurar no cabeçalho `header` da requisição, o ambiente a ser utilizado.\n\n

Ambiente Sandbox

\n\nURL: https://api-integracao.sandbox.vipcommerce.com.br
\nDomainKey: sandbox.vipcommerce.com.br
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}\n\n

Ambiente Produção

\n\nURL: https://api.vipcommerce.com.br
\nDomainKey: {{DOMAIN_KEY}}
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}\n\n

Ambiente Produção - OrganizationID

\n\nURL: https://api.vipcommerce.com.br
\nOrganizationID: 1
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}\n\n# Paginação e limite de itens\n\nAlgumas requisições retornam resultados com páginação. É possível informar a pagina e o limite de itens por página como parâmetros da requisiçao.\n\nRequisições que retornam o objeto pagination é possível informar o número da pagina. O limite é possível informar em qualquer requisição.\n\n
\n  \"pagination\": {\n    \"page_count\": 1,\n    \"current_page\": 1,\n    \"has_next_page\": false,\n    \"has_prev_page\": false,\n    \"count\": 1,\n    \"limit\": null\n  }\n
\n\nExemplo informando número da página como parametro:\n\n
URL/importacao/produtos/?page=2
\n\nExemplo informando limite de itens por pagina:\n\n
URL/importacao/produtos/?limit=10
\n\nExemplo informando número da pagina e limite de itens:\n\n
URL/importacao/produtos/?page=2&limit=10
\n\n# Postman\n\nO Postman é um API Client que permite aos desenvolvedores criar, compartilhar, testar APIs. Permitindo aos usuários criar, salvar e efetuar requisições HTTPs. Disponibilizamos uma coleção que pode ser importada via Postman, conforme o tutorial abaixo:\n\n* Com o Postman devidamente instalado, clique em \"Run in Postman\", conforme a imagem:\n\n\"importando\n\n* Selecione uma opção em \"Open with\", conforme a imagem:\n\n\n\n* A coleção será importada no Postman.\n\n* Após importar a coleção para o Postman será necessário definir as variáveis, conforme forem utilizadas: DOMAIN_KEY, BASIC, URL, ID_OFERTA, ID_PRODUTO, ID_LISTA, ID_ITEM\n\n
\n

Requisições

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4073770","team":312371,"collectionId":"72665720-38be-adfc-c645-15d8af020e52","publishedId":"RVu2mqJo","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4073770/RVu2mqJo","privateUrl":"https://go.postman.co/documentation/4073770-72665720-38be-adfc-c645-15d8af020e52","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2018-04-09T15:19:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/db1d973934f2d7dccd8a551188aae34476b7bbff9de6ab6668dccaf68d48be32","favicon":"https://res.cloudinary.com/postman/image/upload/v1553188984/team/u2f8qtll5tpaehipxhll.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://documenter.gw.postman.com/view/metadata/RVu2mqJo"}