{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"edfc92be-aa8b-4508-a9cf-e86ca2dc1af9","name":"Webstore - Integrações","description":"# Sobre o manual\n\nEsse manual é destinado a explicar como funciona e como devem ser feitas as integrações entre a Webstore e outros sistemas. \n\nEsses outros sistemas podem ser Marketplaces, ERPs, CRMs, etc...\nDurante a explicação no manual, mencionaremos esse outro sistema como **SISTEMA X** para facilitar o entendimento. Ou seja, no caso de uma integração entre a Webstore e o Mercado Livre por exemplo, o Mercado Livre seria o Sistema X.\n\nO manual lhe explicará como criar esse sistema intermediário, que fará o meio de campo entre a Webstore e o Sistema X, chamaremos esse sistema intermediário de **SISTEMA SATÉLITE**, que servirá realmente como uma antena captando informações de um lado e replicando para o outro apenas modificando os formatos e padrões exigidos pelas partes envolvidas.\n\nOu seja, entre uma integração da Webstore e o Mercado Livre por exemplo, a Webstore será a plataforma, o Mercado Livre será o Sistema X e a sua aplicação que fará o meio de campo será o Sistema Satélite.\n\n![Fluxo da integração](https://fileswscdn.wslojas.com.br/wsfiles/painel/images/manual/Fluxo-Integracao.png\n \"Fluxo da integração\")\n\nConforme vemos no fluxo explicado na imagem acima, o sistema satélite ficará exatamente no meio de campo fazendo a ponte entre a plataforma Webstore e a API do sistema X.\n\n\n# Nomenclaturas \n\nNome\t\t| Descrição\n----------\t| ---------------\nPlataforma\t\t| Sistema da Webstore\nSistema Satélite\t| Aplicação que será criada para fazer o meio de campo entre a Webstore e o sistema da empresa terceira \nSistema X\t| Sistema da empresa terceira, EX: Marketplaces, ERPs, CRMs\nhttp://aplicacao-satelite\t| Domínio do seu sistema satélite. Será fornecido pelo time da Webstore no início do projeto.\n\n\n# Antes de começar\n\nSugerimos que assista o vídeo abaixo para entender melhor todo fluxo explicado no manual abaixo.\n\nO vídeo é apenas um complemento ao manual e não exclui a necessidade de leitura do mesmo.\n\n[![Assista o vídeo explicativo sobre o manual](https://fileswscdn.wslojas.com.br/wsfiles/painel/images/manual/VerVideo.png\n \"Fluxo da integração\")\n](https://youtu.be/kAIdKEAZH0c \"Vídeo explicativo\")\n\nhttps://www.youtube.com/watch?v=kAIdKEAZH0c\n\nListaremos a seguir todas as chamadas que o sistema da Plataforma Webstore fará e que precisam ser manipulados para fazer o meio de campo da comunicação entre a plataforma e o Sistema X.\n\nOu seja, essas chamadas abaixo não são chamadas que o sistema satélite que você está criando irá fazer, mas sim, são chamadas que a Webstore fará para seu sistema. Por isso você verá que o endpoint das chamadas usam o domínio **localhost**, pois você usará esse padrão de chamadas para simular as chamadas que a Webstore fará durante o processo de testes.\n\nBasicamente a Webstore vai enviar sempre o mesmo padrão de JSON para as requisições e esperar o mesmo padrão nos retornos, e o sistema satélite ficará responsável por manipular os dados adaptando as informações para o padrão esperado no sistema X e na plataforma. Basicamente fazendo uma tradução dos dados enviados e recebidos para os padrões esperados em ambos os lados.\n\n# Tokens\n\nOs tokens serão enviados no Body da requisição via Raw. Nos exemplos abaixo trabalharemos com uma integração que espera receber (client_id e access_token) porém essas duas informações vão variar de acordo com os dados que o marketplace esperara receber. A plataforma enviará sempre dentro do Array Tokens os dados necessários para a comunicação.\n\n# Endpoint\n\nNas requisições você verá o endpoint utilizando o seguinte padrão:\n\n- http://aplicacao-satelite/Auth\n\nEssa URL deve ser substituída pelo endpoint que você esteja simulando em sua máquina a aplicação.\n\nEssa integração simula dados enviados da plataforma para o sistema satélite que irá fazer o meio de campo entre o sistema X que será integrado, ou seja, todos os posts exibidos abaixo demonstrando requisições feitas a partir da plataforma sentido a aplicação satélite que você está desenvolvendo, essa aplicação receberá os dados, fará uma tratativa, após isso fará alguma requisição para o sistema X e aplicará uma tratativa no retorno imprimindo na tela o padrão esperado pela plataforma.\n\n# Fluxo de dados\n\n- Plataforma envia os tokens para a sua aplicação satélite.\n\n- Sua aplicação recebe os dados, adapta para o padrão esperado no sistema X e faz uma chamada para o endpoint do sistema X\n\n- O sistema X recebe a requisição e retorna uma mensagem\n\n- Sua aplicação satélite verifica a mensagem retornada, trata no formato esperado pela plataforma e imprime a mensagem na tela.\n\n# Projeto base de exemplo\n\nExiste um projeto base, que pode ser usado como referência para lhe ajudar no entendimento. \n\n**Solicite permissão para nossa equipe para ter acesso ao projeto.**\nhttps://github.com/webstore-lojas-virtuais/projeto-base-integracoes-node\n\nNo link acima você verá o projeto que poderá ser usado como base para o inicio do processo.\n\n# Boas práticas\n\nAo iniciar o projeto, o mais aconselhado é fazer uma leitura completa nesse manual da Webstore, mesmo sem fazer nenhum teste, apenas para entendimento geral.\n\nApós isso, entenda quais pontos serão integrados e faça uma leitura completa também do manual da API do Sistema X, entendendo exatamente todos fluxos e boas práticas deles.\n\nApós entender bem o fluxo de ambos os lados, ai sim, inicie o processo de criação do sistema satélite.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1017532","team":3385681,"collectionId":"edfc92be-aa8b-4508-a9cf-e86ca2dc1af9","publishedId":"TzJx8G46","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1017532/TzJx8G46","privateUrl":"https://go.postman.co/documentation/1017532-edfc92be-aa8b-4508-a9cf-e86ca2dc1af9","customColor":{"top-bar":"333","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"333","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.10.0","publishDate":"2024-12-05T19:11:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"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/b0eecb57174d70560cc583e054d5da91f46b1381faa07191d3e50ac4e5734a46","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/TzJx8G46"}