{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"44857433-2f49-42b1-8b4d-24f50eeeda34","name":"API - Loja HostGator","description":"Você acessou a Documentação da Loja HostGator. Este guia irá fornecer toda a base para conexão e ações possíveis de serem realizadas via API. Esperamos guiá-lo por meio de instruções e sanar todas as dúvidas sobre a plataforma.  \nA documentação está em constante melhoria, então não hesite em nos contatar pelo e-mail: [suporte-loja@hostgator.com.br](https://mailto:suporte-loja@hostgator.com.br).\n\nCaso você ainda não tenha uma loja virtual, acesse: [criar uma loja](https://www.hostgator.com.br/loja-hostgator). Preencha o formulário e inicie seus testes. O ambiente é gratuito por um período de 14 dias (Caso necessário, entre em contato com nosso Suporte para estender este período de testes).\n\n# Autenticação\n\nPara poder realizar chamadas para a API da sua loja virtual, é preciso ter um _**appKey**_, saiba como gerar esta credencial acessando: [Como criar appKey](https://suporte-loja.hostgator.com.br/hc/pt-br/articles/27101530896659-Como-localizar-a-API-Key-da-sua-loja).\n\nTodas as requisições para a API terão que conter o parâmetro **appKey** inserido no cabeçalho. Sendo a **appKey** o valor gerado no passo anterior. Essa chave irá garantir maior segurança, evitando que qualquer pessoa faça atualizações em sua loja.\n\n# Requisição e resposta\n\nA Loja HostGator utiliza a estrutura de api REST que segue um conjunto de padrões de arquitetura. Seus dados são enviados e recebidos no formato JSON codificados com UTF-8.\n\nToda requisição será composta por:\n\n**\\* Cabeçalho(headers)**: permite enviar informações adicionais da requisição e resposta, exemplo: autenticação e formato dos dados. O cabeçalho da requisição deverá conter **appKey**, conforme o tópico anterior de Autorização. Além da chave deverá conter um _**Content-Type**_ com valor _**application/json; charset=utf-8**_, visto que os dados são trafegados em JSON.\n\n`Content-Type: application/json; charset=utf-8`\n\n`appKey: {{appKey}}`, onde **{{appkey}}** deverá ser substituído pela chave da sua loja.\n\n**\\* Params**: serão utilizados para paginação conforme veremos a seguir.\n\n`https://{{url-loja}}/ws/wscategorias.json`**`?page=1&limit=50`**\n\nOnde:\n\n**\\* page**: Página a ser retornada na busca.\n\n**\\* limit**: Quantidade de registros que serão retornados por página.\n\n\\* Endpoint: é a exata localização de um recurso, ou seja, quando o cliente faz uma requisição para API está acessando o recurso definido no endpoint. O endpoint base da API será:\n\n`https://{{url-loja}}/ws/`, onde **{{url-loja}}** deverá ser substituído pelo endereço da sua loja\n\n**\\* Body**: conteúdo enviado no corpo da requisição. É utilizado nos verbos POST e PUT.\n\nToda resposta de requisição irá conter um status code, e por meio deste será possível validar se o processamento foi realizado com sucesso. Abaixo segue uma lista dos possíveis status e seus respectivos significados:\n\n**\\* Códigos HTTP 2XX**: requisição realizada com sucesso;  \n**\\* Códigos HTTP 4XX**: indica que a requisição contém alguma informação incorreta(chave de acesso, campos obrigatórios faltando …);  \n**\\* Códigos HTTP 5XX**: Indica erro no servidor da DLoja Virtual ou na aplicação. Pedimos gentilmente que entre em contato pelos nossos canais de atendimento;\n\n# Como paginar uma resposta?\n\nPor padrão, as chamadas GET são paginadas. A paginação evita que a consulta executada fique sobrecarregada, causando um timeout. Todo retorno de listagem possui uma tag pagination composta pelas seguintes informações:\n\n**\\* current_page**: Página atual  \n**\\* page_count**: Total de Páginas  \n**\\* has_next_page**: Informa se existe uma próxima página  \n**\\* has_prev_page**: Informa se existe uma página anterior  \n**\\* count**: Total de registros  \n**\\* limit**: Total de itens por página\n\nPara acessar a próxima página, caso exista, será necessário passar o parâmetro page com a página desejada.\n\nPor padrão as requisições vem com um limite de 50 registros por páginas. Para alterar esse limite basta passar o parâmetro limit com o número desejado, no entanto o número máximo permitido é 50.\n\n# Padrões para datas e números\n\n\\* Data no formato **YYYY-MM-DD**.  \n\\* **Valores numéricos com carecteres “.” como separador decimal**, sem separadores milhares.\n\n# Limites de chamadas\n\nPara garantir o bom desempenho da API, as integrações serão submetidas a um limite de chamadas.  \nO limite é realizado por endpoint, conforme a tabela abaixo:\n\n| **Endpoint** | **Limite de Chamadas** | **Métodos** |\n| --- | --- | --- |\n| Users | **10 por minuto** | POST |\n| Demais endpoints | **200 por minuto** | POST, PUT, GET, DELETE |\n\nCaso sua integração ultrapasse estes limites, será retornado erro **HTTP 403** e a mensagem \"**Too Many Requests**\".  \nÉ importante que ao receber o primeiro erro HTTP 403, sua integração aguarde uma nova janela de tempo para realizar novas chamadas.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31313713","collectionId":"44857433-2f49-42b1-8b4d-24f50eeeda34","publishedId":"2sA3XSALNJ","public":true,"publicUrl":"https://api.lojahostgator.com.br","privateUrl":"https://go.postman.co/documentation/31313713-44857433-2f49-42b1-8b4d-24f50eeeda34","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2024-06-17T13:35:24.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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://lojahostgator.com.br/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://api.lojahostgator.com.br/view/metadata/2sA3XSALNJ"}