{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0b8bec28-b8be-476a-9843-50e1b6d65c3e","name":"MeuEcomm","description":"# 🧑‍💻 Início\n\nBem vindo a documentação oficial do [<b>MeuEcomm</b>](https://meuecomm.com/), está documentação será fundamental para criar uma integração entre seu sistema e o [<b>MeuEcomm</b>](https://meuecomm.com/).\n\nA linguagem de programação que você irá utilizar, depende muito do sistema em que você realizará a integração, para isso, é importante ter conhecimentos referentes a desenvolvimento de sistemas, e compreender as limitações do sistema que você irá integrar.\n\nPara mais detalhes, você pode entrar em contato com nosso time de desenvolvedores, pelo e-mail: [developer@meuecomm.com](https://mailto:developer@meuecomm.com).\n\nTodas as melhorias realizadas em nosso sistema, serão implantadas posteriormente em nossa documentação.\n\nAgrademos a compreensão e que você tenha um bom desenvolvimento.\n\n### 🔗 URL para Integração\n\nPara realizar a integração com o [<b>MeuEcomm</b>](https://meuecomm.com/), você precisará utilizar a nossa URL base para comunicação.\n\n**URL Base:** `https://api.meuecomm.com/`\n\n### 🔐 Comunicação\n\nUtilizamos o padrão `RESTful` para comunicação entre os sistemas e o padrão de mensagens `JSON` para enviar e receber os dados.\n\nTodas as respostas das requisições da API possuirão um indicador chamado `status`, que irá retornar `success` ou `error`, outro indicador é chamado `data`, que irá retornar os dados caso sucesso, ou uma mensagem, caso erro.\n\nCadastros contém o parâmetro `integrado` para que os sistemas consigam verificar a situação do registro, ao cadastrar ou alterar o registro na plataforma do [<b>MeuEcomm</b>](https://meuecomm.com/), automaticamente o registro será gravado com o campo `integrado` igual a 0 (zero).\n\nPara setar o campo `integrado` como 1 (um), basta passar o parâmetro junto ao `JSON` da integração.\n\nO tipo da requisição é importante, já que indica a ação que será executada, portanto:\n\n| Tipo | Descrição |\n| --- | --- |\n| GET | Retorna um registro ou uma lista de registros |\n| POST | Insere um registro |\n| PUT | Atualiza um registro |\n| DELETE | Remove um registro |\n\n### 🔑 Autenticação\n\nO `Token` de autorização e URL da comunicação que fornecemos precisam ser salvos e utilizados em todas as requests para nossa API.\n\nTodas as requisições para a API devem ser feitas passando o `Authorization: Bearer TOKEN` de acesso no header da requisição.\n\nTodas as solicitações da API devem ser feitas por meio de `HTTPS`. Chamadas feitas por `HTTP` simples falharão. Solicitações de API sem autenticação também falharão.\n\nPara encontrar seu `Token`, basta acessar a plataforma do [<b>MeuEcomm</b>](https://meuecomm.com/), no menu \"Configurações\", submenu \"Dados gerais\", e gerar seu `Token`.\n\n**🚨 Cuide do seu** `Token`**, pois com ele, será possivel realizar diversas alterações nos dados do sistema, sendo assim, mantenha ele em segurança. 🚨**\n\nPara alocar o token em sua requisição, deverá ser da seguinte forma:\n\n`Authorization: Bearer TOKEN`\n\n### 🚀 Introdução\n\nApós entender como funciona a autenticação com o [<b>MeuEcomm</b>](https://meuecomm.com/), iremos entrar na etapa de atualização dos registros, sendo assim, é importante lembrar, que os dados de ambos os sistemas, precisam trabalhar em sincronia, para garantia a integridade das informações, com os endpoints fornecidos, você poderá manter os dados alinhados, e garantir a conformidade das informações.\n\nBoa codificação! 🚀🧑‍💻","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34696179","team":6199178,"collectionId":"0b8bec28-b8be-476a-9843-50e1b6d65c3e","publishedId":"2sA3JGeiEk","public":true,"publicUrl":"https://documenter-api.postman.tech/view/34696179/2sA3JGeiEk","privateUrl":"https://go.postman.co/documentation/34696179-0b8bec28-b8be-476a-9843-50e1b6d65c3e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7e39f2"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API para integração com o sistema MeuEcomm."},{"name":"title","value":"MeuEcomm API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"7e39f2"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7e39f2"}}]}},"version":"8.11.6","publishDate":"2024-05-04T13:01:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"MeuEcomm API","description":"API para integração com o sistema MeuEcomm."},"logos":{"logoLight":null,"logoDark":null}},"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/c6480acc46866a52fe54badbaa1714ae2873f258df24136607af4a058bddfd63","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/2sA3JGeiEk"}