{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4733227f-6be0-4a38-a8d1-507f49790bdf","name":"API GAT Core rev. 1.0","description":"\n\nA API do GAT Core foi pensada e desenvolvida com o intuito de ser fácil, mas ao mesmo tempo poderosa!\n\nO GAT Core é uma ferramenta que centraliza e unifica os dados relacionados à Segurança da Informação. Por isso, permitir que cada usuário tenha a possibilidade de integrar o GAT Core com qualquer outra ferramenta é fundamental.\n\n## Como obter sua Chave de API\n\nPara obter sua Chave de API (API Key), siga os passos abaixo:\n\n1. Dentro do GAT, clique sobre o seu nome (no canto direito superior) e, em seguida, em \"Profile\":\n \n\n\n\n1. Clique no botão \"Obter a API Key\":\n \n\n\n\n1. Copie sua Chave de API:\n \n\n\n\nTenha em mente que cada Chave de API é válida para uma única \"Company\". Ou seja, se o seu usuário tiver acesso a mais de uma \"Company\", você precisará seguir esses passos dentro de cada uma.\n\n# Estrutura Geral da API\n\nBuscando facilitar o uso de nossa API, padronizamos as requisições, de modo a seguirem sempre o modelo a seguir:\n\n## Paginação\n\nOs métodos que retornam mais de um resultado (GET e POST) utilizam **paginação**. A paginação funciona utilizando os parâmetros **size** e **page** na URL da requisição. Por padrão (se os parâmetros forem omitidos), o parâmetro **size** será 30 e o **page** será 0. O valor máximo para o parâmetro **size** é 200.\n\nExemplo:\n\n``` bash\ncurl -X GET https://instance/api/v1/users?size=150&page=2\n\n ```\n\nO resultado da requisição sempre retornará um objeto padrão, no seguinte formato:\n\n``` javascript\n{\n \"content\": [\n // Lista de Elementos\n ],\n \"pageable\": {\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false\n },\n \"pageSize\": 3,\n \"pageNumber\": 0,\n \"offset\": 0,\n \"paged\": true,\n \"unpaged\": false\n },\n \"last\": false,\n \"totalPages\": 3,\n \"totalElements\": 8,\n \"first\": true,\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false\n },\n \"numberOfElements\": 8,\n \"size\": 3,\n \"number\": 0\n}\n\n ```\n\n## Métodos HTTP\n\n### GET\n\nO método **GET** é utilizado para **recuperar** todos os elementos (paginados) ou um elemento específico (por ID). Se for utilizado para recuperar todos os elementos, a requisição e o resultado seguirão o modelo de paginação acima.\n\nExemplos:\n\n```\ncurl -X GET https://instance/api/v1/users\n\n ```\n\n```\ncurl -X GET https://instance/api/v1/users/5ab548ebe12f5e056e329776\n\n ```\n\n### POST\n\nDiferente de algumas outras APIs, o método **POST** é utilizado para fazer uma **busca com filtros** (e não para adicionar um novo elemento no banco). A requisição e o resultado seguirão o modelo de paginação acima.\n\nExemplo:\n\n```\ncurl -X POST https://instance/api/v1/users --data '{\"name\": \"Raphael\"}'\n\n ```\n\n### PUT\n\nPara **adicionar** um novo elemento no GAT, utiliza-se o método **PUT**.\n\nExemplo:\n\n```\ncurl -X PUT https://instance/api/v1/users --data '{\"email\": \"email@exemplo.com\", \"nome\": \"Raphael\"}'\n\n ```\n\n### PATCH\n\nO método **PATCH** é utilizado para **atualizar** determinado elemento.\n\nExemplo:\n\n```\ncurl -X PATCH https://instance/api/v1/users/5ab548ebe12f5e056e329776 --data '{\"nome\": \"Raphael 2\"}'\n\n ```\n\n### DELETE\n\nO método **DELETE** é utilizado para **remover** uma lista de elementos.\n\nExemplo:\n\n```\ncurl -X DELETE https://instance.gat.digital/api/v1/users --data '{\"id\": [\"5bd780525ced7f65c39ceacd\"]}'\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13656974","team":1711753,"collectionId":"4733227f-6be0-4a38-a8d1-507f49790bdf","publishedId":"Uyxeq9LN","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13656974/Uyxeq9LN","privateUrl":"https://go.postman.co/documentation/13656974-4733227f-6be0-4a38-a8d1-507f49790bdf","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.10.1","publishDate":"2023-11-17T19:39:15.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":""},"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/Uyxeq9LN"}