{"id":3349,"date":"2025-08-25T09:30:01","date_gmt":"2025-08-25T12:30:01","guid":{"rendered":"https:\/\/staging.facilita.uappi.com.br\/api\/"},"modified":"2026-01-15T11:15:07","modified_gmt":"2026-01-15T14:15:07","slug":"api","status":"publish","type":"post","link":"https:\/\/helpcenter.uappi.com.br\/en\/api\/","title":{"rendered":"API"},"content":{"rendered":"<h2 class=\"wp-block-heading\">O que \u00e9?<\/h2>\n\n\n\n<p>Por meio da API, dois softwares diferentes podem se comunicar mediante <strong>normas e padr\u00f5es estabelecidos no sistema<\/strong>. A sigla se refere a \u201cApplication Programming Interface\u201d, que traduzindo para portugu\u00eas seria<strong> \u201cInterface de programa\u00e7\u00e3o de aplica\u00e7\u00e3o\u201d<\/strong>.&nbsp;<\/p>\n\n\n\n<p>As aplica\u00e7\u00f5es s\u00e3o, nesse contexto, qualquer software que tenha uma utiliza\u00e7\u00e3o \u00fanica. J\u00e1 a interface, se refere \u00e0 conex\u00e3o entre duas aplica\u00e7\u00f5es, assim estabelecem os padr\u00f5es que ser\u00e3o a base da comunica\u00e7\u00e3o.<\/p>\n\n\n\n<p>Diante disso, os desenvolvedores podem <strong>estruturar as solicita\u00e7\u00f5es e respostas usando as informa\u00e7\u00f5es presentes na documenta\u00e7\u00e3o das respectivas APIs<\/strong>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Como a API auxilia no dia a dia?<\/h2>\n\n\n\n<p>As APIs <strong>se comunicam basicamente como cliente e servidor<\/strong>, com a comunica\u00e7\u00e3o feita nas documenta\u00e7\u00f5es ajuda a integrar uma plataforma na outra, sem dificuldades.<\/p>\n\n\n\n<p><strong>&nbsp;Todo sistema que for integrar na API deve criar credenciais diferentes, sejam eles parceiros, ERPs ou outras integra\u00e7\u00f5es.<\/strong><\/p>\n\n\n\n<p>Na Uappi, voc\u00ea pode contar com as<strong> informa\u00e7\u00f5es da documenta\u00e7\u00e3o para realizar a integra\u00e7\u00e3o entre APIs de maneira simples<\/strong>. Com isso, os sistemas podem ser conectados e utilizados no dia a dia.&nbsp;<\/p>\n\n\n\n<p>Para entender na pr\u00e1tica a API na plataforma, \u00e9 preciso acessar o m\u00f3dulo referente ao recurso, que pode ser visto em<strong> \u201c<a href=\"https:\/\/facilita.uappi.com.br\/base-de-conhecimento\/apps\/\">Apps<\/a>\u201d &gt; clicando no \u00edcone de visualiza\u00e7\u00e3o<\/strong>.<\/p>\n\n\n\n<p>O m\u00f3dulo permite criar nova <a href=\"https:\/\/facilita.uappi.com.br\/base-de-conhecimento\/integracoes\/\">integra\u00e7\u00e3o<\/a> e gerenciar as j\u00e1 existentes.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\" alt=\"\"\/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Cria\u00e7\u00e3o de webhooks<\/h3>\n\n\n\n<p>Com as credenciais, <strong>tamb\u00e9m pode ser cadastrado um link externo, que receber\u00e1 as notifica\u00e7\u00f5es por webhook<\/strong>. Essas notifica\u00e7\u00f5es servir\u00e3o somente de alerta, informando que existe um novo conte\u00fado a ser consumido nos endpoints de Produto, Pedido ou Cliente.<\/p>\n\n\n\n<p>As configura\u00e7\u00f5es de APIs e webhooks da Uappi permitem definir a<strong> frequ\u00eancia da execu\u00e7\u00e3o do envio de notifica\u00e7\u00f5es, a quantidade de itens enviados em cada notifica\u00e7\u00e3o por lote e por item.<\/strong> <\/p>\n\n\n\n<p>Al\u00e9m disso, tamb\u00e9m \u00e9 poss\u00edvel definir o<strong> limite de registros processados<\/strong> da fila de atualiza\u00e7\u00e3o de estoque, a <strong>quantidade de execu\u00e7\u00f5es simult\u00e2neas<\/strong> para processo de atualiza\u00e7\u00f5es de estoque e se o <strong>alerta de desligamento de webhook <\/strong>estar\u00e1 ativo ou n\u00e3o.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"857\" height=\"569\" src=\"https:\/\/facilita.uappi.com.br\/wp-content\/uploads\/2023\/06\/image-4.png\" alt=\"\" class=\"wp-image-2549\" srcset=\"https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2023\/06\/image-4.png 857w, https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2023\/06\/image-4-300x199.png 300w, https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2023\/06\/image-4-768x510.png 768w, https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2023\/06\/image-4-18x12.png 18w\" sizes=\"auto, (max-width: 857px) 100vw, 857px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Aprenda a definir a permiss\u00e3o de acesso para integra\u00e7\u00f5es<\/h3>\n\n\n\n<p>A Uappi possui um recurso que visa aprimorar a seguran\u00e7a na API v2. Para isso, em cada credencial de API (ou chave de API) criada, o lojista precisa definir quais endpoints estar\u00e3o dispon\u00edveis para aquela chave de API.<\/p>\n\n\n\n<p>Esse tipo de permiss\u00e3o permite que o lojista<strong>&nbsp;controle a a\u00e7\u00e3o que cada integrador pode ter<\/strong>.&nbsp;<\/p>\n\n\n\n<p><strong>Exemplo:<\/strong>&nbsp;um integrador, que precisa consumir os dados de cliente da loja para realizar a\u00e7\u00f5es de e-mail marketing, pode realizar as consultas nos endpoints destinados \u00e0 exibi\u00e7\u00e3o dos dados de cliente.<\/p>\n\n\n\n<p>Esse integrador precisa somente consumir os dados de cliente, ent\u00e3o, ele n\u00e3o vai precisar criar\/alterar um cliente ou, ent\u00e3o, atualizar um pedido e realizar outras a\u00e7\u00f5es. Com isso, \u00e9 ideal n\u00e3o permitir esse acesso.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Como definir essa configura\u00e7\u00e3o, na pr\u00e1tica?<\/strong><\/h4>\n\n\n\n<p>As configura\u00e7\u00f5es de endpoints permitidas seguir\u00e3o a sintaxe presente na&nbsp;<a href=\"https:\/\/developers.uappi.com.br\/docs\/uappi\/api\/v2\">documenta\u00e7\u00e3o da API v2<\/a>.<\/p>\n\n\n\n<p>Sendo assim, para liberar somente a consulta de clientes, por exemplo, a permiss\u00e3o deve ser configurada para:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>m\u00e9todo: GET;<\/strong><\/li>\n\n\n\n<li><strong>endpoint: v2\/customers.<\/strong><\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/s3.amazonaws.com\/cdn.freshdesk.com\/data\/helpdesk\/attachments\/production\/60118100521\/original\/7THp8ZQDgKjrfszMjJmw4jz7dSOPsy3Fag.png?1721306481\" alt=\"\"\/><\/figure>\n\n\n\n<p>Caso seja para uma consulta espec\u00edfica de um cliente, a configura\u00e7\u00e3o seria desta forma:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>m\u00e9todo: GET;<\/strong><\/li>\n\n\n\n<li><strong>endpoint: v2\/customers\/{idCodigoCliente}.<\/strong><\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/s3.amazonaws.com\/cdn.freshdesk.com\/data\/helpdesk\/attachments\/production\/60118100522\/original\/nM6QVu8K5zP6fqaKJF8dhmuepzPUI-sAew.png?1721306481\" alt=\"\"\/><\/figure>\n\n\n\n<p><strong>Importante:<\/strong>&nbsp;nos exemplos acima,&nbsp;<strong>se for inserida uma letra diferente&nbsp;<\/strong>do que est\u00e1 na documenta\u00e7\u00e3o, o endpoint de consulta&nbsp;<strong>n\u00e3o ser\u00e1 liberado<\/strong>&nbsp;para uso para aquele integrador.<\/p>\n\n\n\n<p>Se estiver na documenta\u00e7\u00e3o como &#8220;<strong>v2\/customers\/{idCodigoCliente}&#8221;<\/strong>&nbsp;e for configurado no painel como &#8220;v2\/customers\/{idCodigoClienteS}&#8221;, s\u00f3 de adicionar a letra &#8220;S&#8221; a consulta de um cliente espec\u00edfico n\u00e3o ser\u00e1 liberada.<\/p>\n\n\n\n<p>Os&nbsp;<strong>m\u00e9todos https (campo &#8220;M\u00e9todo&#8221; no m\u00f3dulo de permiss\u00e3o)<\/strong>, tamb\u00e9m devem ser configurados conforme a documenta\u00e7\u00e3o.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/s3.amazonaws.com\/cdn.freshdesk.com\/data\/helpdesk\/attachments\/production\/60118100523\/original\/p6ahdjC2-CDRO-3UxpiOu2cN7jo285l9OQ.png?1721306481\" alt=\"\"\/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Acesse o recurso<\/strong><\/h4>\n\n\n\n<p>Todos os endpoints que v\u00e3o estar dispon\u00edveis para a chave de API ser\u00e3o listadas na tela de edi\u00e7\u00e3o de uma das chaves de integra\u00e7\u00e3o (chave de API). &nbsp;<\/p>\n\n\n\n<p>As novas chaves de API criada tem todos os endpoints bloqueados, ent\u00e3o, al\u00e9m de criar a chave de API,&nbsp;<strong>ser\u00e1 preciso definir quais endpoints aquela chave de API ter\u00e1 permiss\u00e3o de acesso.<\/strong><\/p>\n\n\n\n<p>Essa configura\u00e7\u00e3o est\u00e1 presente em&nbsp;<strong>\u201cConfigura\u00e7\u00f5es\u201d &gt; \u201cIntegra\u00e7\u00f5es\u201d &gt; \u201cAPI\u201d &gt; clicar no \u00edcone de edi\u00e7\u00e3o da integra\u00e7\u00e3o desejada.<\/strong><\/p>\n\n\n\n<p>Clicando no \u00edcone de edi\u00e7\u00e3o, no final da p\u00e1gina, est\u00e1 presente a configura\u00e7\u00e3o de&nbsp;<strong><em>Endpoints permitidos na integra\u00e7\u00e3o<\/em>.&nbsp;<\/strong><\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/s3.amazonaws.com\/cdn.freshdesk.com\/data\/helpdesk\/attachments\/production\/60118100524\/original\/nREajNpeVVEO9vvqdiQMzO9E07Cyn6OSLw.png?1721306482\" alt=\"\"\/><\/figure>\n\n\n\n<p>As chaves de API criadas antes desta melhoria, continuam com todos os endpoints liberados. Para mudar isso, basta configurar um endpoint a ser liberado.<\/p>\n\n\n\n<p>Lembre-se de digitar o endpoint corretamente para n\u00e3o ocorrer nenhum erro.<\/p>\n\n\n\n<p>Ap\u00f3s a configura\u00e7\u00e3o, clique em&nbsp;<strong>\u201cEnviar\u201d<\/strong>&nbsp;para salvar.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>D\u00favidas?<\/strong><\/h2>\n\n\n\n<p>Se precisar de ajuda com a plataforma, acesse mais conte\u00fados na nossa<a href=\"https:\/\/facilita.uappi.com.br\"> Central de Ajuda<\/a>.<\/p>","protected":false},"excerpt":{"rendered":"<p>O que \u00e9? Por meio da API, dois softwares diferentes podem se comunicar mediante normas e padr\u00f5es estabelecidos no sistema. A sigla se refere a \u201cApplication Programming Interface\u201d, que traduzindo para portugu\u00eas seria \u201cInterface de programa\u00e7\u00e3o de aplica\u00e7\u00e3o\u201d.&nbsp; As aplica\u00e7\u00f5es s\u00e3o, nesse contexto, qualquer software que tenha uma utiliza\u00e7\u00e3o \u00fanica. J\u00e1 a interface, se refere [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[79],"tags":[168,73,51],"modelo-negocio":[2,4,3,216,360],"plataforma":[361,5],"class_list":["post-3349","post","type-post","status-publish","format-standard","hentry","category-geral","tag-api","tag-plataforma","tag-uappi","modelo-negocio-b2b","modelo-negocio-b2b2c","modelo-negocio-b2c","modelo-negocio-marketplace","modelo-negocio-todos","plataforma-todos","plataforma-uappi-v2"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>API &#8211; Uappi Helpcenter<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/helpcenter.uappi.com.br\/en\/api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API &#8211; Uappi Helpcenter\" \/>\n<meta property=\"og:description\" content=\"O que \u00e9? Por meio da API, dois softwares diferentes podem se comunicar mediante normas e padr\u00f5es estabelecidos no sistema. A sigla se refere a \u201cApplication Programming Interface\u201d, que traduzindo para portugu\u00eas seria \u201cInterface de programa\u00e7\u00e3o de aplica\u00e7\u00e3o\u201d.&nbsp; As aplica\u00e7\u00f5es s\u00e3o, nesse contexto, qualquer software que tenha uma utiliza\u00e7\u00e3o \u00fanica. J\u00e1 a interface, se refere [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/helpcenter.uappi.com.br\/en\/api\/\" \/>\n<meta property=\"og:site_name\" content=\"Uappi Helpcenter\" \/>\n<meta property=\"article:published_time\" content=\"2025-08-25T12:30:01+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-15T14:15:07+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\" \/>\n<meta name=\"author\" content=\"Uappi\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Uappi\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/\"},\"author\":{\"name\":\"Uappi\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#\/schema\/person\/309b61cd2044a75c3b274119715a3898\"},\"headline\":\"API\",\"datePublished\":\"2025-08-25T12:30:01+00:00\",\"dateModified\":\"2026-01-15T14:15:07+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/\"},\"wordCount\":864,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#organization\"},\"image\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\",\"keywords\":[\"API\",\"Plataforma\",\"uappi\"],\"articleSection\":[\"Geral\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/helpcenter.uappi.com.br\/api\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/\",\"url\":\"https:\/\/helpcenter.uappi.com.br\/api\/\",\"name\":\"API &#8211; Uappi Helpcenter\",\"isPartOf\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\",\"datePublished\":\"2025-08-25T12:30:01+00:00\",\"dateModified\":\"2026-01-15T14:15:07+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/helpcenter.uappi.com.br\/api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage\",\"url\":\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\",\"contentUrl\":\"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"In\u00edcio\",\"item\":\"https:\/\/helpcenter.uappi.com.br\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#website\",\"url\":\"https:\/\/helpcenter.uappi.com.br\/\",\"name\":\"Uappi Helpcenter\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/helpcenter.uappi.com.br\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#organization\",\"name\":\"Uappi Helpcenter\",\"url\":\"https:\/\/helpcenter.uappi.com.br\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2025\/04\/logo-helpcenter.svg\",\"contentUrl\":\"https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2025\/04\/logo-helpcenter.svg\",\"caption\":\"Uappi Helpcenter\"},\"image\":{\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#\/schema\/logo\/image\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\/\/helpcenter.uappi.com.br\/#\/schema\/person\/309b61cd2044a75c3b274119715a3898\",\"name\":\"Uappi\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g\",\"caption\":\"Uappi\"},\"url\":\"https:\/\/helpcenter.uappi.com.br\/en\/author\/marketing\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API &#8211; Uappi Helpcenter","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/helpcenter.uappi.com.br\/en\/api\/","og_locale":"en_US","og_type":"article","og_title":"API &#8211; Uappi Helpcenter","og_description":"O que \u00e9? Por meio da API, dois softwares diferentes podem se comunicar mediante normas e padr\u00f5es estabelecidos no sistema. A sigla se refere a \u201cApplication Programming Interface\u201d, que traduzindo para portugu\u00eas seria \u201cInterface de programa\u00e7\u00e3o de aplica\u00e7\u00e3o\u201d.&nbsp; As aplica\u00e7\u00f5es s\u00e3o, nesse contexto, qualquer software que tenha uma utiliza\u00e7\u00e3o \u00fanica. J\u00e1 a interface, se refere [&hellip;]","og_url":"https:\/\/helpcenter.uappi.com.br\/en\/api\/","og_site_name":"Uappi Helpcenter","article_published_time":"2025-08-25T12:30:01+00:00","article_modified_time":"2026-01-15T14:15:07+00:00","og_image":[{"url":"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI","type":"","width":"","height":""}],"author":"Uappi","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Uappi","Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/helpcenter.uappi.com.br\/api\/#article","isPartOf":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/"},"author":{"name":"Uappi","@id":"https:\/\/helpcenter.uappi.com.br\/#\/schema\/person\/309b61cd2044a75c3b274119715a3898"},"headline":"API","datePublished":"2025-08-25T12:30:01+00:00","dateModified":"2026-01-15T14:15:07+00:00","mainEntityOfPage":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/"},"wordCount":864,"commentCount":0,"publisher":{"@id":"https:\/\/helpcenter.uappi.com.br\/#organization"},"image":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage"},"thumbnailUrl":"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI","keywords":["API","Plataforma","uappi"],"articleSection":["Geral"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/helpcenter.uappi.com.br\/api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/helpcenter.uappi.com.br\/api\/","url":"https:\/\/helpcenter.uappi.com.br\/api\/","name":"API &#8211; Uappi Helpcenter","isPartOf":{"@id":"https:\/\/helpcenter.uappi.com.br\/#website"},"primaryImageOfPage":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage"},"image":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage"},"thumbnailUrl":"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI","datePublished":"2025-08-25T12:30:01+00:00","dateModified":"2026-01-15T14:15:07+00:00","breadcrumb":{"@id":"https:\/\/helpcenter.uappi.com.br\/api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/helpcenter.uappi.com.br\/api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/helpcenter.uappi.com.br\/api\/#primaryimage","url":"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI","contentUrl":"https:\/\/lh3.googleusercontent.com\/279uaNDaYkkuDYe89o1zinuI9CDPA7VX0zTPAjN3xiMAV4DxU3LDgeLnDXDI0cLf3hxS6RttycfAo8e7Mnhy08ND-QPKvkM9GCuIdU33EZ8mAHQps9O6_knUTzzBbJCHg32a4tnS4M_6Zy8HmbLJiOI"},{"@type":"BreadcrumbList","@id":"https:\/\/helpcenter.uappi.com.br\/api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"In\u00edcio","item":"https:\/\/helpcenter.uappi.com.br\/"},{"@type":"ListItem","position":2,"name":"API"}]},{"@type":"WebSite","@id":"https:\/\/helpcenter.uappi.com.br\/#website","url":"https:\/\/helpcenter.uappi.com.br\/","name":"Uappi Helpcenter","description":"","publisher":{"@id":"https:\/\/helpcenter.uappi.com.br\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/helpcenter.uappi.com.br\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/helpcenter.uappi.com.br\/#organization","name":"Uappi Helpcenter","url":"https:\/\/helpcenter.uappi.com.br\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/helpcenter.uappi.com.br\/#\/schema\/logo\/image\/","url":"https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2025\/04\/logo-helpcenter.svg","contentUrl":"https:\/\/helpcenter.uappi.com.br\/wp-content\/uploads\/2025\/04\/logo-helpcenter.svg","caption":"Uappi Helpcenter"},"image":{"@id":"https:\/\/helpcenter.uappi.com.br\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/helpcenter.uappi.com.br\/#\/schema\/person\/309b61cd2044a75c3b274119715a3898","name":"Uappi","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d5eff8311eab5d01d3632cd1bb864325cc044036e3083bbdf3baa318a7fe85a6?s=96&d=mm&r=g","caption":"Uappi"},"url":"https:\/\/helpcenter.uappi.com.br\/en\/author\/marketing\/"}]}},"_links":{"self":[{"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/posts\/3349","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/comments?post=3349"}],"version-history":[{"count":1,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/posts\/3349\/revisions"}],"predecessor-version":[{"id":4649,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/posts\/3349\/revisions\/4649"}],"wp:attachment":[{"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/media?parent=3349"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/categories?post=3349"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/tags?post=3349"},{"taxonomy":"modelo-negocio","embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/modelo-negocio?post=3349"},{"taxonomy":"plataforma","embeddable":true,"href":"https:\/\/helpcenter.uappi.com.br\/en\/wp-json\/wp\/v2\/plataforma?post=3349"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}