{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cad36472-4be6-41cf-a5eb-230cdc0f9b90","name":"Hubii API","description":"## Ambientes Disponíveis\n\n### Homologação\n\n- URL base: `https://api.staging.hubii.co`\n    \n\n### Produção\n\n- URL base: `https://api.hubii.co`\n    \n\n### Como Alternar\n\nEmbora esta documentação use o ambiente padrão configurado (atualmente **Produção**), você pode configurar outro ambiente no Postman:\n\n1. Importe a collection no Postman.\n    \n2. Crie ou selecione o ambiente desejado (Homologação ou Produção).\n    \n3. As variáveis de ambiente, como `{{base_url}}`, serão ajustadas automaticamente.\n    \n\n## Autenticação com API Key\n\nEsta API utiliza **API Key** como método de autenticação. Todas as requisições feitas aos endpoints protegidos devem incluir uma chave de autenticação no cabeçalho HTTP.\n\n### Como configurar a autenticação?\n\n1. **Receba sua API Key**: A equipe responsável fornecerá uma chave exclusiva para cada parceiro homologado.\n    \n2. **Inclua o header:** **`apikey`**\n    \n\n### Exemplo de Configuração no Postman\n\n1. Abra a aba **Authorization** de sua collection ou requisição no Postman.\n    \n2. Selecione o tipo de autenticação como **API Key**.\n    \n3. Preencha os campos:\n    \n    - **Key**: `apikey`\n        \n    - **Value**:\n        \n    - **Add To**: Escolha `Header`.\n        \n\n> **Dica**: Quando configurada no nível da collection, essa autenticação será aplicada automaticamente a todas as requisições da collection. \n  \n\n### Erros Comuns\n\n- Se a chave `apikey` estiver ausente ou incorreta, a API retornará:\n    \n    - **Código de status**: `401 Unauthorized`\n        \n    - **Mensagem**: `Unauthorized`\n        \n\n## Rate-Limit da API\n\nAs rotas de listagem são de **60 requisições por minuto**, calculada pelo token, não por hub.\n\n- `/hubs`\n    \n- `hubs/:hub_uuid/orders/to-answer`\n    \n- `hubs/:hub_uuid/orders/to-invoice`\n    \n\nAs rotas individuais são de **10 requisições por minuto**, de novo, calculada por token\n\n- `hubs/:hub_uuid/orders/:order_uuid/answer`\n    \n- `hubs/:hub_uuid/orders/:order_uuid/invoice`\n    \n- `notifications/ack`\n    \n\nExclusivamente a rota de detalhes do pedido está configurada para **30 requisições por minuto**\n\n- `hubs/:hub_uuid/orders/:order_uuid`\n    \n\nExclusivamente a rota de notificações está configurada **para 5 requisições por minuto**\n\n- `notifications/:notification_uuid`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34374925","team":6169040,"collectionId":"cad36472-4be6-41cf-a5eb-230cdc0f9b90","publishedId":"2sAYBRGEcV","public":true,"publicUrl":"https://doc.hubii.io","privateUrl":"https://go.postman.co/documentation/34374925-cad36472-4be6-41cf-a5eb-230cdc0f9b90","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2D254D"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2024-11-21T16:33:52.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/a227e2abd84dc3b146cb9b00c01c76e0efa0e15d3d7595e1ffcefc5d935738eb","favicon":"https://res.cloudinary.com/postman/image/upload/v1732208124/team/ec0329432070069ad5e0e76baaea5772.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://doc.hubii.io/view/metadata/2sAYBRGEcV"}