{"id":1796,"date":"2022-02-21T08:05:35","date_gmt":"2022-02-21T07:05:35","guid":{"rendered":"http:\/\/documentation-wp.hub.av.priv\/aurora-vision-apis\/user-guide\/"},"modified":"2022-06-08T09:10:20","modified_gmt":"2022-06-08T08:10:20","slug":"user-guide","status":"publish","type":"page","link":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/aurora-vision-apis\/user-guide\/","title":{"rendered":"Guia de Usuario"},"content":{"rendered":"\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Para garantir ao usu\u00e1rio final uma experi\u00eancia abrangente, criamos um guia do usu\u00e1rio que aborda os principais t\u00f3picos das APIs Aurora Vision com o objetivo de fornecer as principais diretrizes para o uso do servi\u00e7o e suas implementa\u00e7\u00f5es.<br>O guia do usu\u00e1rio ser\u00e1 atualizado ao longo do tempo: adicionaremos novas se\u00e7\u00f5es e refinaremos a discuss\u00e3o de t\u00f3picos ou temas espec\u00edficos e o faremos com base nas defici\u00eancias que destacamos e no feedback obtido dos usu\u00e1rios finais.<\/p>\n\n\n\n<p>Access to the different sections of the guiO acesso \u00e0s diferentes se\u00e7\u00f5es do guia \u00e9 simples: clique em um dos itens da caixa \u00e0 esquerda, voc\u00ea ser\u00e1 redirecionado para a p\u00e1gina que lhe interessa enquanto pode navegar no guia interativamente quando e como quiser.<\/p>\n\n\n\n<p>Para facilitar para voc\u00ea come\u00e7ar a desenvolver com nossas APIs, criamos um modelo que voc\u00ea pode baixar e importar diretamente para o Postman para que voc\u00ea tenha todas as su\u00edtes e chamadas de API atualizadas:<\/p>\n\n\n\n<div class=\"wp-block-columns has-black-color has-text-color has-background\" style=\"background-color:#e6e6e6\">\n<div class=\"wp-block-column\">\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" width=\"752\" height=\"300\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/04\/pm-orange-logo-horiz.png\" alt=\"\" class=\"wp-image-6981\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/04\/pm-orange-logo-horiz.png 752w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/04\/pm-orange-logo-horiz-300x120.png 300w\" sizes=\"(max-width: 752px) 100vw, 752px\" \/><figcaption>Precisa de um guia r\u00e1pido do Postman? V\u00e1 para a <strong>P\u00e1gina<\/strong> <strong>2<\/strong>!<\/figcaption><\/figure>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center\">\n<p class=\"has-text-align-center\"><strong>Aurora Vision Open APIs &#8211; Postman Template<\/strong><br>\u00daltima Atualiza\u00e7\u00e3o: 05\/05\/2022<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center\">\n<div class=\"wp-container-1 wp-block-buttons\">\n<div class=\"wp-block-button has-custom-width wp-block-button__width-100 is-style-fill\"><a class=\"wp-block-button__link\" href=\"http:\/\/documentation-wp.hub.av.priv\/av-api\/av-api-v3.yaml\" style=\"border-radius:0px\" target=\"_blank\" rel=\"noreferrer noopener\" download=\"Aurora_Vision_Open_APIs_REV20220511_Developers_Guide_POSTMAN.yaml\">\u2b73&nbsp;&nbsp;&nbsp;Download Postman Template<\/a><\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<p>O que voc\u00ea est\u00e1 esperando?&nbsp;<strong>Mergulhe no mundo das APIs Aurora Vision e nos mostre do que voc\u00ea \u00e9 capaz<\/strong>!<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<!--nextpage-->\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h2>Guia de configura\u00e7\u00e3o r\u00e1pida do Postman<\/h2>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Esta p\u00e1gina tem como objetivo fornecer as principais informa\u00e7\u00f5es sobre como configurar um espa\u00e7o de trabalho no Postman e importar o modelo de APIs do Aurora Vision. Ap\u00f3s a importa\u00e7\u00e3o da cole\u00e7\u00e3o, explicaremos a estrutura do template de APIs e como realizar uma <code>Authentication <\/code>para o lan\u00e7amento do <code>X-AuroraVision-Token<\/code>.<br>Para obter informa\u00e7\u00f5es detalhadas sobre o Postman e o guia oficial, consulte <a rel=\"noreferrer noopener\" href=\"https:\/\/learning.postman.com\/docs\/getting-started\/introduction\/\" target=\"_blank\"><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\">Postman Learning Center<\/mark><\/a>.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>Fa\u00e7a o download do modelo de APIs do Aurora Vision, inicie o Postman e configure seu espa\u00e7o de trabalho.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"390\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1024x390.png\" alt=\"\" class=\"wp-image-7675\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1024x390.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1536x585.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Clique em <strong>Import<\/strong> para importar uma nova cole\u00e7\u00e3o no Postman, uma janela dedicada ser\u00e1 aberta.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"391\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-1024x391.png\" alt=\"\" class=\"wp-image-7713\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-1024x391.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-1536x586.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import-1-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Fa\u00e7a upload do modelo de APIs do Aurora Vision que voc\u00ea baixou inicialmente como um arquivo (<em>n\u00e3o se preocupe se for um arquivo <code>.txt<\/code> , a codifica\u00e7\u00e3o do modelo segue o modelo Swagger de acordo com <code>YAML <\/code>idioma e o Postman ir\u00e1 reconhec\u00ea-lo de qualquer maneira<\/em>)<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"391\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-1024x391.png\" alt=\"\" class=\"wp-image-7721\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-1024x391.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-1536x586.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_settings-1-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Nas configura\u00e7\u00f5es de importa\u00e7\u00e3o do modelo, defina:<\/p>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<ul><li><strong>Naming requests <\/strong>como Fallback;<\/li><li><strong>Set indent character<\/strong> como Space;<\/li><li><strong>Collapse redundant folder<\/strong> como Active;<\/li><li><strong>Optimize conversion<\/strong> como Active;<\/li><li><strong>Request parameter generation<\/strong> como Example;<\/li><li><strong>Response parameter generation<\/strong> como Example;<\/li><li><strong>Folder organization<\/strong> como Tags;<\/li><li><strong>Include auth info in example request<\/strong> como Active;<\/li><li><strong>Disable optional parameters<\/strong> como Inactive;<\/li><\/ul>\n<\/div>\n<\/div>\n\n\n\n<p>Clique em Importar e aguarde o Postman concluir a importa\u00e7\u00e3o do modelo.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"389\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-1024x389.png\" alt=\"\" class=\"wp-image-7756\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-1024x389.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-768x292.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-1536x584.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_import_done-2048x778.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Neste momento, uma cole\u00e7\u00e3o foi criada no workspace, na guia Collections, e uma pasta, na guia APIs, ambas com o nome Aurora Vision APIs.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"390\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-1024x390.png\" alt=\"\" class=\"wp-image-7767\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-1024x390.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-1536x585.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_workspace-1-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Ao expandir a pasta, estar\u00e1 dispon\u00edvel toda a hierarquia de chamadas oferecidas, divididas por tags, que nada mais s\u00e3o do que as su\u00edtes tamb\u00e9m mostradas no modelo Swagger.<\/p>\n\n\n\n<p>Na pasta <strong>Authentication<\/strong>, selecione <code>GET Authenticate<\/code>.<br>A API de autentica\u00e7\u00e3o ser\u00e1 aberta, com a guia <strong>Params <\/strong>destacada.<br>Para ter uma resposta correta, para a libera\u00e7\u00e3o correta de um <code>X-AuroraVision-Token<\/code>, \u00e9 necess\u00e1rio se autenticar no servi\u00e7o com as credenciais do Aurora Vision e o <code>X-AuroraVision-ApiKey<\/code>.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"392\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-1024x392.png\" alt=\"\" class=\"wp-image-7791\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-1024x392.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-300x115.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-768x294.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-1536x589.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/postman_authenticate-1-2048x785.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Clique na guia <strong>Authorization <\/strong>e, a partir da\u00ed, selecione <strong>Basic Auth<\/strong> no menu suspenso.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"390\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-1024x390.png\" alt=\"\" class=\"wp-image-7801\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-1024x390.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-1536x585.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/basic_auth-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Digite o <strong>UserID <\/strong>e a <strong>Password <\/strong>da sua conta do Aurora Vision.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"391\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-1024x391.png\" alt=\"\" class=\"wp-image-7809\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-1024x391.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-300x114.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-768x293.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-1536x586.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/credentials-2048x781.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Clique na guia <strong>Headers <\/strong>e insira a <code>X-AuroraVision-ApiKey<\/code>.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" width=\"1024\" height=\"378\" src=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-1024x378.png\" alt=\"\" class=\"wp-image-7820\" srcset=\"http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-1024x378.png 1024w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-300x111.png 300w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-768x283.png 768w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-1536x567.png 1536w, http:\/\/documentation-wp.hub.av.priv\/wp-content\/uploads\/2022\/05\/api-key-2048x755.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Clique em <strong>Send<\/strong> e a chamada ser\u00e1 enviada para a Aurora Vision que, uma vez verificadas as credenciais e a <code>X-AuroraVision-ApiKey<\/code> responder\u00e1 (<em>JSON default format<\/em>) que conter\u00e1 o <code>X-AuroraVision-Token<\/code>.<\/p>\n\n\n\n<p>O token \u00e9 o <code>header <\/code>de todas as chamadas de APIs oferecidas e expira ap\u00f3s 60 minutos de inatividade completa; isso significa que n\u00e3o h\u00e1 necessidade de executar a <code>GET Authentication<\/code> API toda vez para emitir um novo <code>X-AuroraVision-Token<\/code> se o que voc\u00ea j\u00e1 possui n\u00e3o expirou.<\/p>\n\n\n\n<p>Para obter um guia completo sobre chamadas dispon\u00edveis, consulte o p\u00e1gina <a href=\"http:\/\/documentation-wp.hub.av.priv\/aurora-vision-apis\/openapi-preview\/\" data-type=\"page\" data-id=\"74\"><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\">OpenAPIs Swagger<\/mark><\/a>.<\/p>\n\n\n\n<div style=\"height:10px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Para garantir ao usu\u00e1rio final uma experi\u00eancia abrangente, criamos um guia do usu\u00e1rio que aborda os principais t\u00f3picos das APIs Aurora Vision com o objetivo de fornecer as principais diretrizes para o uso do servi\u00e7o e suas implementa\u00e7\u00f5es.O guia do usu\u00e1rio ser\u00e1 atualizado ao longo do tempo: adicionaremos novas se\u00e7\u00f5es e refinaremos a discuss\u00e3o de [&hellip;]<\/p>\n","protected":false},"author":4,"featured_media":0,"parent":1768,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/pages\/1796"}],"collection":[{"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/comments?post=1796"}],"version-history":[{"count":60,"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/pages\/1796\/revisions"}],"predecessor-version":[{"id":10567,"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/pages\/1796\/revisions\/10567"}],"up":[{"embeddable":true,"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/pages\/1768"}],"wp:attachment":[{"href":"http:\/\/documentation-wp.hub.av.priv\/pt-pt\/wp-json\/wp\/v2\/media?parent=1796"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}