{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"35b426a9-2962-44d4-b19c-69507064f711","name":"Documentação da API","description":"# 📄 Comece por aqui\n\nNesta documentação você irá aprender como integrar funil de vendas e contatos na Wappbot via API.\n\n## **Por que usar uma API?**\n\nAPIs (Interfaces de Programação de Aplicações) facilitam a integração entre sistemas, permitindo que aplicativos se comuniquem de forma eficiente e segura. Elas ajudam a automatizar processos, aumentar a produtividade e conectar diferentes serviços de maneira ágil, possibilitando a criação de experiências mais ricas e conectadas. Com uma API bem estruturada, você pode expandir as funcionalidades de seus sistemas e facilitar a inovação sem reinventar a roda.\n\n## Autenticação\n\nComo a maioria das APIs, a API da Hubiss requer que você providencie uma chave API para realizar suas requisições.\n\n## Como recuperar o token da API na Hubiss?\n\nPara gerar seu novo Token de Autenticação, você deve clicar no ícone do canto superior direito, clicar em Desenvolvedores (API).\n\n<img src=\"https://content.pstmn.io/b3c9812c-039c-4422-b7a7-4b567a38b256/aW1hZ2UucG5n\" width=\"450\" height=\"355\">\n\nNa página aberta, preencha os dados solicitados e clique em Gerar Token, então um novo token será gerado para você.\n\n<img src=\"https://content.pstmn.io/bbd6a8bf-a4c7-4ed3-a5d2-cd2a8f3b3e58/aW1hZ2UucG5n\" width=\"506\" height=\"288\">\n\n\\> Por questões de segurança, a Wappbot não pode recuperar o Token Antigo de forma alguma e nem mantém salvo.  \nPortanto o único responsável pelo seu Token é você, guarde-o em um lugar seguro, de preferência com senha.\n\n## Realizando requisições com a chave api\n\nEm toda documentação dos endpoints, ao lado direito da tela você vai encontrar os comandos prontos para rodar, basta copiar e adaptar o código a sua realidade.  \nNossa autenticação no momento é utilizada o padrão Bearer, ou seja, em toda requisição realizada, você deve estar enviando no cabeçalho da requisição como exemplo sempre o seguinte comando:\n\n``` shell\ncurl --request GET \\\n     --url 'https://wappbot.pro/api/v1/funnels?per_page=15¤t_page=1' \\\n     --header 'Accept: application/json' \\\n     --header 'Authorization: Bearer api_key'\n\n ```\n\n## Limitação\n\nEm toda listagem de itens, por padrão irá retornar 15 registros, com um limite de 100 registros por página.\n\n## Limite de requisições\n\nSeja gentil. Lançaremos um erro número 429 (Too Many Requests) se você enviar muitas solicitações rapidamente. Cada token tem no máximo 10 solicitações por segundo.\n\n## Paginação\n\nEm todas as requisições de listagem de dados retornam uma coleção de recursos que são paginados.  \nPor exemplo, a consulta de funis.  \nToda a resposta paginada é retornada no seguinte formato:\n\n``` json\n{\n    \"data\": [\n        {\n            ...\n        }\n    ],\n    \"links\": {\n        \"first\": \"https://wappbot.pro/api/v1/funnels?page=1\",\n        \"last\": \"https://wappbot.pro/api/v1/funnels?page=2\",\n        \"prev\": null,\n        \"next\": \"https://wappbot.pro/api/v1/funnels?page=2\"\n    },\n    \"meta\": {\n        \"current_page\": 1,\n        \"from\": 1,\n        \"last_page\": 27,\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"« Previous\",\n                \"active\": false\n            },\n            {\n                \"url\": \"https://wappbot.pro/api/v1/funnels?page=1\",\n                \"label\": \"1\",\n                \"active\": true\n            },\n            {\n                \"url\": \"https://wappbot.pro/api/v1/funnels?page=2\",\n                \"label\": \"2\",\n                \"active\": false\n            },\n            {\n                \"url\": \"https://wappbot.pro/api/v1/funnels?page=2\",\n                \"label\": \"Next »\",\n                \"active\": false\n            }\n        ],\n        \"path\": \"https://wappbot.pro/api/v1/funnels\",\n        \"per_page\": 1,\n        \"to\": 2,\n        \"total\": 27\n    }\n}\n\n ```\n\nPara usar os parâmetros aqui informados, você deve envia-los por GET na requisição desejada.  \nAbaixo segue os parâmetros que alteram a forma como a requisição é retornada.\n\n| **Nome** | **Descrição** | **Exemplo** |\n| --- | --- | --- |\n| per_page | Limita o número de registros para apresentar em cada página | 10 |\n| current_page | Define o número da página atual com o número de registros informado | 1 |\n\n> Para facilitar o entendimento e navegação sequencial dos dados, disponibilizaremos automaticamente links para navegar entre a próxima página ou página anterior. \n  \n\n## Erros\n\n### Erros 400\n\nGeralmente acontece quando você fornece algo na requisição que faça quebrar com a requisição, por exemplo um json quebrado.\n\n### Erros 401\n\nAcontecem quando sua chave de acesso não funciona ou está errado.  \nVerifique se o seu token mudou e se a sua conta continua válida na Wappbot.\n\n### Erros 404\n\nAcontecem quando um registro que você está buscando ou querendo excluir não existe na Hubiss.\n\n### Erros 422\n\nAcontecem geralmente por uma falta de padronização na sua requisição.  \nAqui o sistema retornará um aviso de erro com a lista de erros que ocorreram na validação da sua requisição.  \nAtente-se ao retorno e sempre leia a documentação novamente para entender se você não tratou uma requisição de forma incorreta.\n\nEstrutura de Retorno Padrão\n\n``` json\n{\n    \"success\": false,\n    \"message\": \"Validation errors\",\n    \"data\": {\n        \"status\": [\n            \"Cannot change status now, check documentation\"\n        ]\n    }\n}\n\n ```\n\n### Erros 500 - 501\n\nOcorrem quando ocorreu um erro interno no servidor, pode ser qualquer coisa, não se preocupe que quando um erro assim acontece a Wappbot é automaticamente notificada para resolver o problema o quanto antes.  \nCaso o problema continue por muito tempo, por favor, entre em contato conosco para verificar como está o andamento da resolução desse erro.\n\n## **Dúvida ou sugestão?**\n\nEstamos sempre felizes em lhe ajudar da melhor maneira possível, sinta-se a vontade para entrar em contato conosco por e-mail: [api@wappbot.pro](https://mailto:api@wappbot.pro)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"40030440","collectionId":"35b426a9-2962-44d4-b19c-69507064f711","publishedId":"2sAYBViC5Q","public":true,"publicUrl":"https://documenter-api.postman.tech/view/40030440/2sAYBViC5Q","privateUrl":"https://go.postman.co/documentation/40030440-35b426a9-2962-44d4-b19c-69507064f711","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":"https://content.pstmn.io/04dd4200-82d1-4ab7-8db4-df6292135a5f/bG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/70be43c1-942f-4522-9f19-beee00a38872/bG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-11-27T03:40:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/70be43c1-942f-4522-9f19-beee00a38872/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/04dd4200-82d1-4ab7-8db4-df6292135a5f/bG9nby5wbmc="}},"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":""},"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/2sAYBViC5Q"}