<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:googleplay="http://www.google.com/schemas/play-podcasts/1.0"><channel><title><![CDATA[API Playbook: Developer Experience]]></title><description><![CDATA[Mergulhe no mundo do DX! Explore técnicas, melhores práticas e insights que garantem uma experiência excepcional para desenvolvedores. Entenda como otimizar a jornada de desenvolvimento, a documentação, as ferramentas e muito mais para criar uma interface amigável e eficaz entre os desenvolvedores e suas APIs.]]></description><link>https://www.apiplaybook.com/s/developer-experience</link><image><url>https://substackcdn.com/image/fetch/$s_!GdFN!,w_256,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fb08af87d-4b66-473f-a437-07a9f5881317_1280x1280.png</url><title>API Playbook: Developer Experience</title><link>https://www.apiplaybook.com/s/developer-experience</link></image><generator>Substack</generator><lastBuildDate>Tue, 28 Apr 2026 13:25:05 GMT</lastBuildDate><atom:link href="https://www.apiplaybook.com/feed" rel="self" type="application/rss+xml"/><copyright><![CDATA[David Ruiz]]></copyright><language><![CDATA[pt-br]]></language><webMaster><![CDATA[apiplaybook@substack.com]]></webMaster><itunes:owner><itunes:email><![CDATA[apiplaybook@substack.com]]></itunes:email><itunes:name><![CDATA[David Ruiz]]></itunes:name></itunes:owner><itunes:author><![CDATA[David Ruiz]]></itunes:author><googleplay:owner><![CDATA[apiplaybook@substack.com]]></googleplay:owner><googleplay:email><![CDATA[apiplaybook@substack.com]]></googleplay:email><googleplay:author><![CDATA[David Ruiz]]></googleplay:author><itunes:block><![CDATA[Yes]]></itunes:block><item><title><![CDATA[Como criar e manter um portal de desenvolvedores eficiente]]></title><description><![CDATA[Mari Moreira - Mercado Livre]]></description><link>https://www.apiplaybook.com/p/como-criar-e-manter-um-portal-de</link><guid isPermaLink="false">https://www.apiplaybook.com/p/como-criar-e-manter-um-portal-de</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Mon, 20 Nov 2023 10:00:49 GMT</pubDate><enclosure url="https://substack-video.s3.amazonaws.com/video_upload/post/138155251/a0b903b5-e2c7-42f8-9a90-e1633ad91601/transcoded-00000.png" length="0" type="image/jpeg"/><content:encoded><![CDATA[<p>Junte-se a <a href="https://www.linkedin.com/in/marimoreiratw/">Mari Moreira</a>, Lead Technical Writer do Mercado Livre, nesta apresenta&#231;&#227;o do API Connect Conference 2023 (APICON). Aprenda as melhores pr&#225;ticas e estrat&#233;gias para projetar e gerenciar um portal de desenvolvedores bem-sucedido que possa ajudar a impulsionar a inova&#231;&#227;o, melhorar a colabora&#231;&#227;o entre equipes e fornecer uma experi&#234;ncia de usu&#225;rio e&#8230;</p>
      <p>
          <a href="https://www.apiplaybook.com/p/como-criar-e-manter-um-portal-de">
              Read more
          </a>
      </p>
   ]]></content:encoded></item><item><title><![CDATA[O que é developer experience?]]></title><description><![CDATA[Conforme as organiza&#231;&#245;es identificam o valor de solu&#231;&#245;es baseadas em nuvem e de experi&#234;ncias digitais, elas tamb&#233;m passam a dar mais aten&#231;&#227;o n&#227;o s&#243; para a experi&#234;ncia do consumidor, mas do desenvolvedor. Pensar e planejar como esse profissional vai adotar ou operar tais tecnologias &#233; uma medida estrat&#233;gica que trar&#225; bons frutos &#224; empresa.]]></description><link>https://www.apiplaybook.com/p/o-que-e-developer-experience</link><guid isPermaLink="false">https://www.apiplaybook.com/p/o-que-e-developer-experience</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Thu, 04 Nov 2021 20:24:38 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/2e137e51-6114-45ef-8ac8-6470ea28e7f3_6000x4000.jpeg" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!bMHX!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!bMHX!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 424w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 848w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!bMHX!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;O que &#233; developer experience?&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="O que &#233; developer experience?" title="O que &#233; developer experience?" srcset="https://substackcdn.com/image/fetch/$s_!bMHX!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 424w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 848w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!bMHX!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F0b4462be-9fd1-490b-9dce-11522efe974b_6000x4000.jpeg 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">None</figcaption></figure></div><p>Conforme as organiza&#231;&#245;es identificam o valor de solu&#231;&#245;es baseadas em nuvem e de experi&#234;ncias digitais, elas tamb&#233;m passam a dar mais aten&#231;&#227;o n&#227;o s&#243; para a experi&#234;ncia do consumidor, mas do <strong>desenvolvedor</strong>. Pensar e planejar como esse profissional vai adotar ou operar tais tecnologias &#233; uma medida estrat&#233;gica que trar&#225; bons frutos &#224; empresa.&nbsp;</p><p>Semelhante &#224; User Experience (UX), a Developer Experience (DX) se concentra na jornada do desenvolvedor. Contar com uma DX de qualidade n&#227;o &#233; mais opcional, mas um imperativo quando pensamos em competitividade no mercado. Ela representa todas as intera&#231;&#245;es de um desenvolvedor com seu produto, seja ele um c&#243;digo aberto, framework, API, SDK, ferramenta ou servi&#231;o.</p><p>Durante o processo de elabora&#231;&#227;o de um novo produto, o olhar das organiza&#231;&#245;es costuma se voltar para a experi&#234;ncia do usu&#225;rio, no caso, o consumidor. Por&#233;m, ao mesmo tempo, &#233; preciso entendimento do que os devs necessitam para executar suas tarefas.</p><p>As APIs, por exemplo, assumiram protagonismo no mundo dos neg&#243;cios, sendo agora consideradas at&#233; produtos de muitas organiza&#231;&#245;es. Tratando dessa tecnologia, os desenvolvedores tamb&#233;m deveriam ser vistos como uma prioridade, j&#225; que s&#227;o seus principais usu&#225;rios.</p><p>Encarando os desenvolvedores como consumidores de APIs, &#233; poss&#237;vel proporcionar uma boa DX&nbsp; a partir de:</p><ul><li><p>APIs &#250;teis;</p></li><li><p>APIs est&#225;veis;</p></li><li><p>APIs escal&#225;veis;</p></li><li><p>APIs bem documentadas.</p></li></ul><p>O fluxo de trabalho deve ser o mais suave poss&#237;vel, ou seja, a documenta&#231;&#227;o n&#227;o deve somente oferecer informa&#231;&#245;es de como interagir com a API, mas tamb&#233;m guias de in&#237;cio r&#225;pidos e exemplos de trabalho.</p><p>Logo, a cultura DX bem enraizada representa menos frustra&#231;&#245;es e projetos mais bem sucedidos para o time de desenvolvedores. E como isso pode ser traduzido em valor estrat&#233;gico para seu neg&#243;cio?</p><p>No caso de desenvolvedores que lidam com APIs, estes s&#227;o alguns dos benef&#237;cios:</p><ol><li><p><strong>Melhor acompanhamento dos dados</strong></p></li></ol><p>A partir do acompanhamento de dados, podemos detectar poss&#237;veis falhas e irregularidades internas. Com isso, h&#225; uma melhor an&#225;lise das APIs, tendo uma vis&#227;o mais ampla da sua efic&#225;cia, toler&#226;ncia aos erros e facilidade de uso.</p><ol start="2"><li><p><strong>Alinhamento dos processos</strong></p></li></ol><p>Compreender melhor o usu&#225;rio, ou seja, o pr&#243;prio desenvolvedor, implica em identificar mais rapidamente as &#225;reas que precisam de ajustes e suporte.</p><ol start="3"><li><p><strong>Manuten&#231;&#227;o das informa&#231;&#245;es</strong></p></li></ol><p>Seu desenvolvedor deve contar com um guias e manuais, descrevendo as regras de uso das APIs e disponibilizando sua documenta&#231;&#227;o. Tutoriais tamb&#233;m podem demonstrar boas pr&#225;ticas e fornecer um ponto de partida para solu&#231;&#245;es personalizadas. Com isso, &#233; poss&#237;vel melhor compreens&#227;o dos fluxos e atualiza&#231;&#227;o &#225;gil das informa&#231;&#245;es sempre que necess&#225;rio.</p><p>A escolha de ferramentas e frameworks &#233; capaz de influenciar positivamente na produtividade e na experi&#234;ncia de sua equipe de desenvolvimento. Por exemplo, uma maneira de proporcionar uma &#243;tima DX &#233; optar por ferramentas que diminuam a carga cognitiva.</p><p>Ao escolher as ferramentas para seu time de desenvolvedores, procure pensar nas seguintes quest&#245;es:</p><ul><li><p>Como ser&#225; a experi&#234;ncia de onboarding?</p></li><li><p>Algu&#233;m da equipe j&#225; usou a ferramenta antes? Pode dar feedback?</p></li><li><p>H&#225; documenta&#231;&#245;es dispon&#237;veis sobre a ferramenta?</p></li><li><p>H&#225; ferramentas similares para fazer comparativos?</p></li></ul><p>Vale destacar que, al&#233;m de adotar uma cultura DX, um dos passos fundamentais &#233; medi-la. Voc&#234; pode fazer isso identificando a frequ&#234;ncia de implanta&#231;&#227;o, ou o tempo de produ&#231;&#227;o para um novo servi&#231;o.</p><p>Para outros crit&#233;rios mais subjetivos, como a satisfa&#231;&#227;o dos devs no ambiente de desenvolvimento, fa&#231;a pesquisas e fale com os profissionais. E lembre-se, conforme os produtos e servi&#231;os digitais evoluem, a experi&#234;ncia do desenvolvedor permanecer&#225; um elemento relevante para o sucesso das empresas.</p><div><hr></div><p><strong>Quer conversar sobre DX e APIs? <a href="https://calendly.com/api-pedro/assessment-api-playbook">Clique aqui</a> e marque uma reuni&#227;o</strong></p><p>Este artigo foi escrito por Luana Brigo e publicado originalmente em <a href="/api-playbook/o-que-e-developer-experience/">Prensa.li</a>.</p>]]></content:encoded></item><item><title><![CDATA[Desenvolvedores: Como as leis de proteção de dados (LGPD e GDPR) afetam o seu trabalho]]></title><description><![CDATA[Com poucos meses para a Lei Geral de Prote&#231;&#227;o aos Dados entrar em vigor &#233; natural que surjam d&#250;vidas e questionamentos sobre a efic&#225;cia da lei, seus principais desafios e quais as consequ&#234;ncias ela trar&#225; para diferentes setores, especialmente para empresas ligadas a &#225;rea de tecnologia.]]></description><link>https://www.apiplaybook.com/p/desenvolvedores-como-leis-de-protecao-de-dados-lgpd-e-gdpr-afetam-o-seu-trabalho</link><guid isPermaLink="false">https://www.apiplaybook.com/p/desenvolvedores-como-leis-de-protecao-de-dados-lgpd-e-gdpr-afetam-o-seu-trabalho</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Tue, 12 May 2020 15:38:02 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/c2a5d3b5-dc79-4dda-a04e-acc8afed649e_1400x933.jpeg" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!UZEl!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!UZEl!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!UZEl!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/d4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;Desenvolvedores: Como as leis de prote&#231;&#227;o de dados (LGPD e GDPR) afetam o seu trabalho&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="Desenvolvedores: Como as leis de prote&#231;&#227;o de dados (LGPD e GDPR) afetam o seu trabalho" title="Desenvolvedores: Como as leis de prote&#231;&#227;o de dados (LGPD e GDPR) afetam o seu trabalho" srcset="https://substackcdn.com/image/fetch/$s_!UZEl!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!UZEl!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd4fa56ed-0a0c-4572-a0d3-6d86081d1304_1400x933.jpeg 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">None</figcaption></figure></div><p>Com poucos meses para a&nbsp;<a href="https://medium.com/@i9dvdr/sem-delongas-o-que-voc%C3%AA-precisa-saber-da-lgpd-est%C3%A1-aqui-7ee7fef22be6">Lei Geral de Prote&#231;&#227;o aos Dados</a>&nbsp;entrar em vigor&nbsp;&#233; natural que&nbsp;surjam&nbsp;d&#250;vidas e questionamentos sobre a efic&#225;cia da lei, seus principais desafios e quais as consequ&#234;ncias ela trar&#225; para diferentes setores, especialmente para empresas ligadas a &#225;rea de tecnologia.</p><p>Uma das melhores formas de tra&#231;ar um par&#226;metro &#233; os resultados da implanta&#231;&#227;o da GDPR, afinal de contas a Lei Geral de Prote&#231;&#227;o de Dados teve como modelo o regulamento da UE.</p><p>Para dar a voc&#234; uma no&#231;&#227;o dos valores envolvidos,<strong>&nbsp;um ano ap&#243;s a GDPR ter entrado em vigor foram aplicados aproximadamente &#8364;56 milh&#245;es em penalidades</strong>&nbsp;e mais de 64 mil notifica&#231;&#245;es de vazamentos, sendo 280 dos casos fora da UE.</p><p>Ao mesmo tempo que vemos estes n&#250;meros significativos resultantes de penalidades e vazamentos, temos mais de 375 mil empresas com registro formal de um Data Protection Officer (DPO) e mais 500 mil que planeja contratar um profissional respons&#225;vel pelos dados.</p><p><strong>A quest&#227;o que fica: como um desenvolvedor por entrar em conformidade com a GDPR?</strong></p><p>Algo do qual podemos ter certeza com a implanta&#231;&#227;o da GDPR &#233; o cuidado e aten&#231;&#227;o necess&#225;rios na cria&#231;&#227;o de sites e servi&#231;os online, &#233; necess&#225;rio mais transpar&#234;ncia com a forma de coletamos e usamos dados armazenados.</p><p>Os desenvolvedores possuem um papel importante a desempenhar a partir da vig&#234;ncia da LGPD. Afinal de contas, a pr&#225;tica de prote&#231;&#227;o de dados envolve tanto o lado do desenvolvimento (elabora&#231;&#227;o de c&#243;digos, dados e seguran&#231;a) quanto o lado comercial/neg&#243;cios.</p><p>Vou exemplificar alguns pontos relacionados ao trabalho de um desenvolvedor (p&#243;s-GDPR) para deixar mais claro como voc&#234; saiba o que esperar para a <strong>agosto de 2020</strong>, quando a LGPD entrar em vigor.</p><h3><strong>1. Padr&#245;es de Programa&#231;&#227;o</strong></h3><p>A import&#226;ncia de um fluxo de trabalho saud&#225;vel de prote&#231;&#227;o de dados e a preven&#231;&#227;o da perda ou captura de dados desnecess&#225;rios exige que o desenvolvedor tenha como base um conjunto de bibliotecas de c&#243;digos, ferramentas e estruturas. Logo, estar em conformidade com o GDPR significa criar uma lista de padr&#245;es e metodologias aprovados para codifica&#231;&#227;o e testes.</p><p>A chegada do GDPR n&#227;o promoveu uma lista de linguagens de programa&#231;&#227;o e ferramentas certas ou erradas, o que realmente importa aqui &#233; se tudo o que voc&#234; utiliza &#233; claramente definido e seguido para cada situa&#231;&#227;o em que voc&#234; ou sua empresa utilizam.</p><p>Obviamente isso n&#227;o significa que em nenhum momento do seu trabalho voc&#234; n&#227;o poder&#225; alterar as ferramentas ou mesmo as infraestruturas, mas ser&#225; preciso garantir que estas sejam reconhecidas e documentadas como as estruturas a serem usadas.</p><p>Os padr&#245;es de codifica&#231;&#227;o tamb&#233;m precisam ser preventivos. Dessa forma, voc&#234; deve desativar m&#243;dulos n&#227;o seguros ou desnecess&#225;rios, especialmente em APIs e bibliotecas de terceiros</p><h3><strong>2.&nbsp;Consentimento do usu&#225;rio (back-end e front-end)</strong></h3><p>Rever a prote&#231;&#227;o de dados levando em conta as diretrizes do GDPR se relaciona com passar o controle dos dados aos usu&#225;rios utilizando de mecanismos de consentimento e acesso de sujeito. A partir da&#237; o usu&#225;rio deve ser informado a respeito do fluxo de seus dados e de seus direitos sobre os mesmos.</p><p>No front-end, o desenvolvedor deve fornecer bons mecanismos de consentimento e controle do usu&#225;rio. As aplica&#231;&#245;es precisam oferecer o controle ideal sobre as configura&#231;&#245;es de consentimento atrav&#233;s de pain&#233;is de controle, pain&#233;is do usu&#225;rio, configura&#231;&#245;es de conta e centros de privacidade.</p><p>Al&#233;m disso, &#233; importante que seja fornecida uma interface de direitos de acesso de sujeitos individuais, garantindo que estes editem e corrijam informa&#231;&#245;es, baixem e excluam dados.</p><p>J&#225; no back-end, o desenvolvedor precisa impor o consentimento e a escolha do usu&#225;rio. Quando o usu&#225;rio configura uma conta pela primeira vez ele deve usufruir de configura&#231;&#245;es ideais de privacidade por padr&#227;o.</p><p>Outro ponto &#233; que ao longo do desenvolvimento do back-end ser&#225; essencial que o desenvolvedor garanta uma documenta&#231;&#227;o com data e hora do consentimento do usu&#225;rio, como ele o deu e se o retirou ou n&#227;o.</p><h3><strong>3. Requisitos de Projeto</strong></h3><p>Quando falamos de um fluxo de desenvolvimento consciente do GDPR, requisitos de projeto tamb&#233;m s&#227;o parte integrante. Nesse caso, a prote&#231;&#227;o de dados por padr&#227;o necessita de um desenvolvimento voltado para a minimiza&#231;&#227;o:</p><ul><li><p>Coleta de uma quantidade m&#237;nima dados pessoais, ou seja, somente os realmente necess&#225;rios, tanto no front-end quanto no back-end.</p></li><li><p>N&#227;o vincula&#231;&#227;o dos dados pessoais a outros grupos de dados armazenados em um &#250;nico local.</p></li><li><p>Remo&#231;&#227;o de dados pessoais e de identifica&#231;&#227;o no caso de agrega&#231;&#227;o de dados</p></li></ul><p>Embora as diretrizes que comp&#245;em o GDPR exijam que voc&#234; defina agendas de reten&#231;&#227;o e exclus&#227;o para todos seus dados pessoais, n&#227;o h&#225; nenhuma obrigatoriedade que voc&#234; exclua tudo como regra. Voc&#234; pode muito bem manter registradas informa&#231;&#245;es de compras por 5, 10 anos para fins fiscais. Desde que tudo seja documentado e justificado, manter os dados &#233; aceit&#225;vel.</p><p>Vale ressaltar que a exclus&#227;o dos dados, quando estes n&#227;o forem mais necess&#225;rios, pode ser feita tanto automaticamente quanto por meio de a&#231;&#245;es do usu&#225;rio.</p><p>Outro aspecto do design do sistema est&#225; ligado a privacidade. Dessa forma, dados pessoais n&#227;o devem estar &#224; vista de todos, nem no frontend e nem no back-end. Al&#233;m disso n&#227;o &#233; recomendado que todos os usu&#225;rios tenham acesso universal.</p><p>Por quest&#245;es de seguran&#231;a e privacidade, os dados do usu&#225;rio precisam estar criptografados, estejam eles em tr&#226;nsito ou em repouso.</p><h3><strong>3. Manuten&#231;&#227;o e testes</strong></h3><p>Adequar-se ao GDPR significa adicionar privacidade e prote&#231;&#227;o de dados por padr&#227;o em seus processos de teste. Isso deve complementar os procedimentos existentes, como testes de penetra&#231;&#227;o (<em>pentest</em>).</p><p>Tais procedimentos de teste de privacidade devem prever como usu&#225;rios n&#227;o autorizados obteriam acesso a dados no seu sistema. Para isso voc&#234; precisa ter os seguintes questionamentos:</p><ul><li><p>Os dados de usu&#225;rios s&#227;o armazenados nos cookies de login?</p></li><li><p>Algu&#233;m poderia ter acesso aos dados acionando intencionalmente um erro?</p></li><li><p>H&#225; alertas externos sobre viola&#231;&#245;es de dados, potenciais ou reais?</p></li><li><p>A criptografia utilizada para informa&#231;&#245;es pessoais foi a mais forte?</p></li><li><p>Logs das aplica&#231;&#245;es n&#227;o est&#227;o comprometendo a privacidade do usu&#225;rio?</p></li></ul><p>Sendo assim, voc&#234; precisa pensar de forma um tanto maliciosa a respeito de como seus dados podem escapar e onde eles n&#227;o deveriam estar.</p><p><strong>A regra de ouro da LGPD e do GDPR: documente tudo. Se n&#227;o est&#225; registrado ent&#227;o n&#227;o aconteceu</strong>. Os resultados do seus testes e m&#233;todos usados para alcan&#231;&#225;-los devem ser anotados e acionados como documentos vivos. Voc&#234; precisar&#225; comprovar em situa&#231;&#245;es extremas de vazamento que voc&#234; utilizou a melhor tecnologia existente no per&#237;odo em que o desenvolvimento ou manuten&#231;&#227;o aconteceram.</p><p>Caso voc&#234; queira saber um pouco mais sobre como desenvolvedores se adaptaram ao GDPR, leia mais em&nbsp;<a href="https://developer.mastercard.com/blog/mastercard-developers-and-gdpr">MasterCard Developers</a>.</p><h3><strong>O que todo desenvolvedor precisa saber</strong></h3><p>Um conceito importante ligado ao GDPR &#233; o porqu&#234; da coleta de dados, ou seja, quando voc&#234; fizer a coleta &#233; necess&#225;rio que ela tenha um objetivo espec&#237;fico e justific&#225;vel. Isso n&#227;o significa que voc&#234; n&#227;o possa coletar os dados que desejar, mas eles dever&#227;o apresentar uma finalidade. Isso sem contar que o usu&#225;rio precisa ser notificado e concordar com a coleta.</p><p>Uma boa dica &#233; adicionar estas justificativas como um DoD (Definition of Done) da est&#243;ria ou escopo de projeto &#224; ser desenvolvido pelo time t&#233;cnico.</p><p>Logo, como desenvolvedor, seja para entrar em conformidade com o GDPR ou a LGPD, &#233; essencial que voc&#234; tenha debates com o respons&#225;vel pelo produto (Product Owner) e com parceiros sobre sua adequa&#231;&#227;o &#224;s leis de prote&#231;&#227;o de dados, assim como conversar com outros desenvolvedores mais familiarizados com os c&#243;digos e arquitetura de seus sistemas. Procure compreender como eles processam, armazenam e manipulam os dados.</p><p>Ofere&#231;a uma API para gerenciar o consentimento do seu usu&#225;rio e, principalmente, as vers&#245;es do consentimento, dado que a solu&#231;&#227;o digital &#233; viva e pode, ao longo do tempo, solicitar ou utilizar os dados de maneira distinta da inicialmente proposta.</p><p><strong>Lembre-se a privacidade dos dados necessita ser protegida a cada passo do usu&#225;rio, do login ao logout.</strong></p><p>No caso de APIs vale a pena ficar atento ao seu gerenciamento, afinal ele &#233; a base para uma uma arquitetura compat&#237;vel com a LGPD. O gerenciamento permite que as empresas criem rapidamente regras sobre obten&#231;&#227;o de consentimento e assim informem seus usu&#225;rios acerca de regulamenta&#231;&#245;es ligadas ao acesso e a portabilidade de dados.</p><p>A partir da vig&#234;ncia da LGPD, ser&#225; preciso que as organiza&#231;&#245;es revejam o ciclo de vida de suas APIs e implementem controles mais rigorosos e robustos para a prote&#231;&#227;o dos dados.</p><h3><strong>O papel de um DPO (data protection officer)</strong></h3><p>A nova regulamenta&#231;&#227;o sobre prote&#231;&#227;o de dados entre em vigor em agosto de 2020, o que significa que para evitar penalidades de at&#233; R$ 50 Milh&#245;es por infra&#231;&#227;o as organiza&#231;&#245;es brasileiras devem estar alinhadas &#224;s normas da LGPD.</p><p>Nesse novo cen&#225;rio surge a figura do Data Protection Officer (DPO) ou segundo tradu&#231;&#227;o literal Oficial de Prote&#231;&#227;o de Dados. Esse profissional fica a cargo do canal de comunica&#231;&#227;o entre a empresa, os donos das informa&#231;&#245;es e a Autoridade Nacional de Prote&#231;&#227;o de Dados (ANPD). Sua figura tem tomado mais espa&#231;o desde a GDPR e foi absorvido, com adapta&#231;&#245;es, pela LGPD. Trata-se de um</p><p>nova posi&#231;&#227;o do n&#237;vel estrat&#233;gico, posi&#231;&#227;o esta que merece aten&#231;&#227;o por parte das empresas.</p><p>Os desenvolvedores s&#227;o profissionais que pelos seus conhecimentos t&#233;cnicos e habilidades devem estar preparados para assumir esse papel de guardi&#245;es das de gerenciamento de dados apropriadas. Similar a um diretor de conformidade, o DPO possui no&#231;&#245;es bem abrangentes dos requisitos de gerenciamento de dados e como implement&#225;-los em cada projeto elaborado.</p><p>O ideal &#233; que as organiza&#231;&#245;es j&#225; nomeiem profissionais para ocupar esse cargo, antes o in&#237;cio efetivo do vigor da lei, o que ajudaria ainda mais no processo de adapta&#231;&#227;o &#224; LGDP composto por an&#225;lises da maturidade da empresa em rela&#231;&#227;o ao tema e desenvolvimento de relat&#243;rios de impacto &#224; prote&#231;&#227;o de dados pessoais contendo as caracter&#237;sticas dos tratamentos de dados, os riscos para os titulares e avalia&#231;&#227;o sobre os impactos sobre a prote&#231;&#227;o de dados.</p><p><em><strong>Se voc&#234; quer saber mais sobre Governan&#231;a de APIs, se cadastre no&nbsp;<a href="https://www.apiplaybook.com/">API Playbook</a>&nbsp;e tenha acesso &#224; entrevistas, video-aulas e materiais voltados ao ciclo de vida de APIs.</strong></em></p><div><hr></div><p><strong>Quer conversar sobre DX e APIs? <a href="https://calendly.com/api-pedro/assessment-api-playbook">Clique aqui</a> e marque uma reuni&#227;o.</strong></p><p>Este artigo foi escrito por David Ruiz e publicado originalmente em <a href="/api-playbook/desenvolvedores-como-leis-de-protecao-de-dados-lgpd-e-gdpr-afetam-o-seu-trabalho/">Prensa.li</a>.</p>]]></content:encoded></item><item><title><![CDATA[Investir em Developer Experience te dará APIs de sucesso]]></title><description><![CDATA[Termos como UX (experi&#234;ncia de usu&#225;rio) e UI (interface de usu&#225;rio) n&#227;o s&#227;o nenhuma novidade faz um tempo, especialmente se voc&#234; trabalha ou se interessa por assuntos que envolvam tecnologia.]]></description><link>https://www.apiplaybook.com/p/saiba-por-que-investir-em-uma-developer-experience-te-dara-apis-de-sucesso</link><guid isPermaLink="false">https://www.apiplaybook.com/p/saiba-por-que-investir-em-uma-developer-experience-te-dara-apis-de-sucesso</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Tue, 12 May 2020 15:30:17 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/98ba6d55-8fb1-4b15-9fae-31c434fe82bb_1400x933.jpeg" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!KXyq!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!KXyq!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!KXyq!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;Investir em Developer Experience te dar&#225; APIs de sucesso&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="Investir em Developer Experience te dar&#225; APIs de sucesso" title="Investir em Developer Experience te dar&#225; APIs de sucesso" srcset="https://substackcdn.com/image/fetch/$s_!KXyq!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!KXyq!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F8dcd309f-1e0e-4e9f-a49b-4fdcbbc9273c_1400x933.jpeg 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">None</figcaption></figure></div><p>Termos como UX (experi&#234;ncia de usu&#225;rio) e UI (interface de usu&#225;rio) n&#227;o s&#227;o nenhuma novidade faz um tempo, especialmente se voc&#234; trabalha ou se interessa por assuntos que envolvam tecnologia. Uma boa experi&#234;ncia de usu&#225;rio &#233; a chave para a ado&#231;&#227;o de um produto. Afinal de contas, se ningu&#233;m entender como us&#225;-lo, ningu&#233;m ter&#225; interesse nele.</p><p>O mesmo vale quando falamos de APIs (Interface de Programa&#231;&#227;o de Aplicativos). Seus principais usu&#225;rios s&#227;o os desenvolvedores. Quando eles&nbsp;gostem de usar uma plataforma e consideram ela eficiente, as chances dessa plataforma ser escolhida&nbsp;aumentam.</p><p>A cada dia os Devs&nbsp;se tornam mais ativos e exigentes com suas experi&#234;ncias e qualidade dos produtos que utilizam, principalmente quando falamos de APIs. E a chave para APIs de sucesso est&#225; justamente na Developer Experience (DX), a experi&#234;ncia do desenvolvedor</p><h4><strong>Mas o que &#233; Developer Experience?</strong></h4><p>A Developer Experience &#233; o equivalente a quando o usu&#225;rio principal do produto &#233; o desenvolvedor.</p><p>Na DX h&#225; uma preocupa&#231;&#227;o do desenvolvedor quanto &#224; usabilidade do produto, SDKs, documenta&#231;&#245;es, frameworks, solu&#231;&#245;es open source e, claro, APIs.</p><p>Simplificando, a DX &#233; importante pelos mesmos motivos que uma UX.&nbsp;Ela &#233; o agregado de todas as experi&#234;ncias que um desenvolvedor tem ao interagir com sua plataforma. Al&#233;m disso, desenvolvedores com uma boa DX utilizam o produto em quest&#227;o por mais tempo e at&#233; o promovem.</p><p>Quando falamos em uma boa DX, quero dizer que ela deve atender &#224;s necessidades dos seus clientes. Mas antes de tudo, voc&#234; precisa entender quem &#233; o seu cliente. E o que vemos por a&#237; s&#227;o empresas de tecnologia que ainda n&#227;o tem essa compreens&#227;o.</p><p>Por exemplo, a API como um produto. Ela&nbsp;n&#227;o deve ser f&#225;cil de usar apenas para seu p&#250;blico t&#233;cnico, embora isso seja extremamente importante. Ela tamb&#233;m precisa de uma usabilidade facilitada pensando nos tomadores de decis&#227;o. Contudo, estes n&#227;o t&#234;m os mesmos conhecimentos t&#233;cnicos que um desenvolvedor, e ter&#227;o que decidir pelo uso ou n&#227;o da plataforma.</p><p>Sua API precisa atrair tanto o p&#250;blico t&#233;cnico quanto n&#227;o t&#233;cnico, e para isso seu processo de ado&#231;&#227;o de API deve ser o mais direto poss&#237;vel.</p><p><strong>Dessa forma, uma API agrega dois p&#250;blicos diferentes:</strong></p><ol><li><p><strong>Neg&#243;cio:</strong> Product Owner, Profissionais de Inova&#231;&#227;o ou at&#233; mesmo o CEO, especialmente no caso de startups e pequenas empresas</p></li><li><p><strong>T&#233;cnicos: </strong>CTO, CIO, CDO e CSO, arquitetos de integra&#231;&#227;o e desenvolvedores</p></li></ol><p>A jornada da API, da sua descoberta at&#233; seu consumo, precisa responder a pelo menos 4 perguntas de seus consumidores:</p><ul><li><p>Por que devo us&#225;-la?</p></li><li><p>Como me registro?</p></li><li><p>Por onde come&#231;o?</p></li><li><p>Como posso testar?</p></li></ul><p>As respostas para cada uma dessas perguntas devem ser claras para seus usu&#225;rios desde o in&#237;cio. A partir da&#237; &#233; que voc&#234; poder&#225; identificar seus pontos de valor.</p><h4><strong>Ent&#227;o minha estrat&#233;gia de APIs deve considerar a Developer Experience (DX)?</strong></h4><p>Atualmente, existem&nbsp;milhares de APIs dispon&#237;veis, com diversas funcionalidades e prop&#243;sitos.&nbsp;Por isso, ganhar aquele destaque e sair na frente da concorr&#234;ncia &#233; fundamental quando se trata de dar uma aten&#231;&#227;o especial aos desenvolvedores e oferecer a eles uma boa experi&#234;ncia no uso das APIs.</p><p>De que serve uma &#243;tima API se o desenvolvedor n&#227;o a utiliza, porque considera sua documenta&#231;&#227;o e onboarding complicados? Ou por que ele n&#227;o obt&#233;m respostas do suporte ou retorno de seus feedbacks? Por isso afirmo que cuidar da sua Developer Experience &#233; vital para ter sucesso nas suas estrat&#233;gias de APIs.</p><p>O mesmo vale para o caso de APIs internas. A m&#225; experi&#234;ncia relacionada a APIs internas&nbsp;pode resultar em desperd&#237;cio de tempo e dinheiro, j&#225; que seus desenvolvedores ir&#227;o refazer seus componentes, ou v&#227;o gastar sua energia tentando entender como utiliz&#225;-la adequadamente. Isso significa que APIs com excelente DX evitam trabalho desnecess&#225;rio e tarefas repetitivas.&nbsp;O&nbsp;resultado, na verdade, &#233; uma maior produtividade e acelera&#231;&#227;o do time-to-market.</p><h4><strong>Experi&#234;ncia do desenvolvedor em equipes</strong></h4><p>Para que a constru&#231;&#227;o de uma&nbsp;developer experience funcione dentro dos times de sua empresa, &#233; necess&#225;rio que toda comunica&#231;&#227;o, especialmente entre time de neg&#243;cios e t&#233;cnico, estejam o mais clara poss&#237;vel.&nbsp; Uma comunica&#231;&#227;o eficaz pode agregar um valor incr&#237;vel ao seu projeto e ajudar a lan&#231;ar produtos melhores.</p><p>A padroniza&#231;&#227;o no fluxo de trabalho tamb&#233;m &#233; mais do que bem-vinda, sem contar as ferramentas dispon&#237;veis. Todos na equipe devem usar as mesmas ferramentas para a mesma tarefa.&nbsp;O mesmo se aplica &#224; configura&#231;&#227;o.</p><p>Uma configura&#231;&#227;o id&#234;ntica inclui majoritariamente ferramentas compartilhadas, como as de CI / CD ou ambientes de teste. Isso n&#227;o implica que todos devam apresentar exatamente as mesmas configura&#231;&#245;es / prefer&#234;ncias de usu&#225;rio.</p><p>A integra&#231;&#227;o deve ser um ponto de aten&#231;&#227;o da mesma forma.&nbsp; Se novos desenvolvedores ingressarem na equipe, suas atividades devem ficar claras. Eles precisam saber quais ferramentas devem instalar, e a quem recorrer para tirar suas d&#250;vidas. E para isso, uma documenta&#231;&#227;o, n&#227;o apenas de software, mas dos fluxos de trabalho e processos, serve de suporte.</p><h3><strong>Pilares da Developer Experience</strong></h3><p><strong>1. Fun&#231;&#227;o</strong></p><p>Ela &#233; essencial para a DX. Uma devtool (ferramenta de desenvolvedor) &#233; t&#227;o boa quanto a funcionalidade que ela oferece. N&#227;o adianta tentar encobrir uma funcionalidade pobre com uma est&#233;tica bonita, desviando assim a aten&#231;&#227;o do problema. Se a API n&#227;o operar corretamente, ele n&#227;o possui serventia para o desenvolvedor e nem colabora para a DX.</p><p><strong>2. Estabilidade</strong></p><p>Sem uma API est&#225;vel n&#227;o h&#225; confian&#231;a. Um dos elementos mais cr&#237;ticos para uma boa Developer Experience &#233; a garantia das atividades e de um desempenho confi&#225;vel. A estabilidade tamb&#233;m est&#225; relacionada &#224; capacidade de corrigir erros. Sem ela, as APIs e suas funcionalidades, mesmo que boas, tornam-se irrelevantes.</p><p><strong>3. Facilidade de uso</strong></p><p>A facilidade em utilizar uma API n&#227;o est&#225; relacionada&nbsp;apenas a&nbsp;como navegar nas suas ferramentas, mas tamb&#233;m a como acessar o que for necess&#225;rio em todas as etapas da jornada. Tudo de forma eficiente e r&#225;pida.</p><p>Documenta&#231;&#227;o rica, casos de uso, comunidades, filtros intuitivos, pesquisas realizadas anteriormente e pontos mais profundos como desempenho agregam velocidade ao processo de intera&#231;&#227;o dos desenvolvedores com sua API e aumentam o engajamento.</p><p><strong>4. Clareza</strong></p><p>Quando falo em clareza, me refiro a uma interface simples e intuitiva, que traga todas as informa&#231;&#245;es necess&#225;rias para ajudar o desenvolvedor a realizar suas atividades di&#225;rias e atenuar erros de usu&#225;rios. Logo, clareza &#233; sobre o desenvolvedor ter visibilidade total das poss&#237;veis consequ&#234;ncias de uma a&#231;&#227;o.</p><h3><strong>Invista sem medo em uma DX</strong></h3><p>Muitas das experi&#234;ncias digitais que impulsionam a economia de hoje t&#234;m sua origem no trabalho e desempenho de desenvolvedores. Poucas s&#227;o as empresas que n&#227;o se enquadram nessa realidade. Uma verdade:<strong>&nbsp;Os desenvolvedores s&#227;o colaboradores estrat&#233;gicos t&#227;o essenciais quanto qualquer outro ator no pipeline de produtos de uma empresa</strong>. Portanto, o envolvimento do desenvolvedor deve ser um item priorit&#225;rio para qualquer organiza&#231;&#227;o.</p><p>Isso significa que APIs n&#227;o deveriam ser tratadas simplesmente como um middleware, mas como produtos para desenvolvedores. Elas exigem, como qualquer outro produto, uma equipe qualificada para gerenci&#225;-las, sem contarmos todo o envolvimento com o cliente, ciclos de feedbacks e as intera&#231;&#245;es ao longo do processo.</p><p>Se voc&#234; pretende criar e lan&#231;ar uma API de sucesso, precisa come&#231;ar a investir em uma &#243;tima experi&#234;ncia de desenvolvedor. Tal experi&#234;ncia deve incluir:</p><ul><li><p>Conte&#250;do relevante sobre a API para grupos-alvo, e n&#227;o apenas para desenvolvedores;</p></li><li><p>APIs de f&#225;cil entendimento;</p></li><li><p>Fluxos de integra&#231;&#227;o;</p></li><li><p>Gloss&#225;rio&nbsp;para explicar os termos;</p></li><li><p>Guia de primeiros passos descrevendo as etapas de integra&#231;&#227;o;</p></li><li><p>Exemplos&nbsp; nas linguagens de programa&#231;&#227;o mais comuns.</p></li><li><p>Refer&#234;ncia da API&nbsp;com detalhes dos terminais, solicita&#231;&#245;es e respostas esperadas, al&#233;m de c&#243;digos de erro;</p></li><li><p>As notas de versionamento da API;</p></li><li><p>Limita&#231;&#245;es da API,&nbsp;incluindo cotas de solicita&#231;&#227;o e limita&#231;&#245;es de frequ&#234;ncia.</p></li></ul><h4><strong>API em primeiro lugar para um boa DX</strong></h4><p>Quando falamos de consumidores de APIs, abordamos o tema de&nbsp;desenvolvedores, e como&nbsp;sua experi&#234;ncia com o produto API pode levar ao sucesso ou fracasso de uma API. A estrat&#233;gia API First ajuda na cria&#231;&#227;o de APIs mais consistentes, melhor projetadas e documentadas, garantindo uma Developer Experience positiva e uma menor curva de aprendizado.</p><p>Ao projetar primeiro sua API, voc&#234; garante uma melhor developer experience, j&#225; que tudo o que for feito ser&#225; constru&#237;do com base nela.&nbsp;</p><p>Al&#233;m disso, os times de desenvolvimento conseguem trabalhar em paralelo, uma vez que n&#227;o seja&nbsp;incomum que processos de desenvolvimento sejam s&#237;ncronos e n&#227;o paralelos.&nbsp;</p><p>Por exemplo, os primeiros a atuarem na cria&#231;&#227;o de um novo servi&#231;o s&#227;o os membros do time de pesquisa. Em seguida, a equipe de back-end come&#231;a a escrever o prot&#243;tipo. A participa&#231;&#227;o do front-end e Q&amp;A s&#243; ocorrer&#225; ap&#243;s a conclus&#227;o do prot&#243;tipo e o compartilhamento da documenta&#231;&#227;o da API.</p><p>O empecilho surge quando h&#225; a necessidade de aprimoramento por conta de um bug, fazendo este ciclo recome&#231;ar, tomando um tempo valioso de todos os envolvidos e at&#233; atrasando o lan&#231;amento do produto ou servi&#231;o em quest&#227;o.</p><p>Sendo assim, a estrat&#233;gia possibilita o trabalho paralelo de equipes. Ela envolve tamb&#233;m o estabelecimento de um contrato entre determinados servi&#231;os por parte dos times de desenvolvimento.</p><p>Tal contrato ir&#225; permitir que as equipes trabalhem em mais de uma API ao mesmo tempo. Dessa forma, um desenvolvedor n&#227;o precisa esperar a atualiza&#231;&#227;o seguinte de uma API antes de passar para a pr&#243;xima. Um contrato possibilita a simula&#231;&#227;o e testes das depend&#234;ncias de APIs com base na defini&#231;&#227;o de API estabelecida.</p><p><strong>Developer Experience Owner (DXO)</strong></p><p>Uma adi&#231;&#227;o &#224; equipe de desenvolvimento que pode colaborar para o bom andamento da developer experience &#233; o Developer Experience Owner (DXO). Um membro do time de desenvolvimento designado para cuidar da DX da equipe, selecionando e configurando as ferramentas, definindo fluxos de trabalho, integrando novos membros e sendo uma pessoa de contato central para todas as quest&#245;es relacionadas &#224; experi&#234;ncia do desenvolvedor.</p><p>Outro aspecto do DXO &#233; manter os desenvolvedores &#8220;sincronizados&#8221;, ou seja, garantir que todos saibam o que est&#225; acontecendo, quando e quais atualiza&#231;&#245;es s&#227;o necess&#225;rias. O que inclui a preven&#231;&#227;o de uma forma ruim do shadow IT, no qual os desenvolvedores usam ferramentas ou processos sem avisar a ningu&#233;m porque temem que isso n&#227;o seja permitido.</p><p><em>Promova inova&#231;&#227;o e expanda&nbsp;seus neg&#243;cios com a <strong><a href="https://www.apiplaybook.com/">API Playbook</a></strong>,&nbsp;consultoria especializada em DX e governan&#231;a de APIs</em></p><p>Este artigo foi escrito por Luana Brigo e publicado originalmente em <a href="/api-playbook/saiba-por-que-investir-em-uma-developer-experience-te-dara-apis-de-sucesso/">Prensa.li</a>.</p>]]></content:encoded></item><item><title><![CDATA[Descubra a experiência personalizada de compra através de APIs]]></title><description><![CDATA[Atualmente podemos falar de experi&#234;ncias conectadas, temos a possibilidade de controlar objetos dom&#233;sticos inteligentes por IoT (Internet of Things ou Internet das Coisas) atrav&#233;s de um aplicativo m&#243;vel ou mesmo solicitar encomendas usando uma assistente de voz.]]></description><link>https://www.apiplaybook.com/p/descubra-experiencia-personalizada-de-compra-atraves-de-apis</link><guid isPermaLink="false">https://www.apiplaybook.com/p/descubra-experiencia-personalizada-de-compra-atraves-de-apis</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Tue, 12 May 2020 14:46:02 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/7c716951-41a3-4f28-8cb1-e5c9884518aa_1400x933.jpeg" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!1Jee!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!1Jee!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!1Jee!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/c7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;Descubra a experi&#234;ncia personalizada de compra atrav&#233;s de APIs&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="Descubra a experi&#234;ncia personalizada de compra atrav&#233;s de APIs" title="Descubra a experi&#234;ncia personalizada de compra atrav&#233;s de APIs" srcset="https://substackcdn.com/image/fetch/$s_!1Jee!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 424w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 848w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 1272w, https://substackcdn.com/image/fetch/$s_!1Jee!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fc7a982d1-ed8b-4935-9fd6-156ad22a834d_1400x933.jpeg 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">None</figcaption></figure></div><p>Atualmente podemos falar de experi&#234;ncias conectadas, temos a possibilidade de controlar objetos dom&#233;sticos inteligentes por IoT (Internet of Things ou Internet das Coisas) atrav&#233;s de um aplicativo m&#243;vel ou mesmo solicitar encomendas usando uma assistente de voz.</p><p>Isso por que nossa cultura est&#225; cada vez mais digitalizada, o que acaba alterando nossos h&#225;bitos como um simples ato de compra. E com isso tivemos uma mudan&#231;a estrutural do varejo com a vinda de novos players e a transforma&#231;&#227;o de modelos de neg&#243;cios em marketplaces.</p><p>Alguns desses modelos de marketplaces criaram processos disruptivos em muitas ind&#250;strias. Temos nomes tradicionais como eBay, Amazon, Mercado Livre, B2W (Americanas, Submarino e ShopTime) e Magazine Luiza aqui no Brasil.</p><p>A mudan&#231;a em nossa forma de consumo resultou em uma converg&#234;ncia do offline para o online e com isso a ind&#250;stria de marketplace percebeu uma valiosa oportunidade, j&#225; que o consumidor muitas vezes prefere a praticidade de pesquisar e comprar no digital, ainda que continue retirando o produto na loja mais pr&#243;xima de sua casa.</p><p>O c&#226;mbio para o meio digital pode ser comprovado atrav&#233;s da&nbsp;<a href="https://www.paypal.com/stories/br/4-edico-da-pesquisa-paypal-ipsos-o-perfil-do-consumidor-online">4&#170; edi&#231;&#227;o da pesquisa PayPal/Ipsos</a>: o perfil do consumidor online. O estudo Paypal/Ipsos indicou uma prov&#225;vel movimenta&#231;&#227;o de R$270 bilh&#245;es no com&#233;rcio eletr&#244;nico, crescendo 17% este ano e 18% em 2020.</p><p>O estudo tamb&#233;m indicou os 4 fatores mais decisivos que far&#227;o o consumidor escolher comprar por uma loja virtual:</p><ol><li><p>Maior conveni&#234;ncia &#8212; 63% (dos 34 mil entrevistados)</p></li><li><p>Mudan&#231;a no rendimento dispon&#237;vel &#8212; 46%</p></li><li><p>Aumento no n&#250;mero de plataformas de com&#233;rcio online &#8212; 32%</p></li><li><p>Mudan&#231;as na economia &#8212; 25%</p></li></ol><p>Por isso, marketplaces tem investido em tecnologias, como Machine Learning, Intelig&#234;ncia Artificial, Analytics e Big Data. Tudo isso para oferecer maior qualidade no servi&#231;o, seguran&#231;a e uma melhor Customer Experience (CX), ou seja, experi&#234;ncia do consumidor.</p><p>Uma Customer Experience &#233; formada por a&#231;&#245;es voltadas para a melhoria e otimiza&#231;&#227;o das intera&#231;&#245;es entre cliente e a marca. Saber trabalhar e investir nesse relacionamento &#233; vital para qualquer empresa. E hoje mais do que nunca, uma boa CX precisa de recursos tecnol&#243;gicos para ser aprimorada continuamente. O uso de dispositivos, ferramentas e redes sociais, por exemplo, colabora na facilita&#231;&#227;o da rela&#231;&#227;o cliente-empresa, fazendo-a mais acess&#237;vel e r&#225;pida.</p><h3><strong>Como as APIs podem revolucionar a sua Customer Experience</strong></h3><p>Uma das tecnologias aliadas na aprimora&#231;&#227;o da Customer Experience s&#227;o as APIs (Interfaces de Programa&#231;&#227;o de Aplicativos). Componentes importantes, as APIs permitem que as empresas capacitem seus desenvolvedores na cria&#231;&#227;o novas experi&#234;ncias conectadas, incluindo compartilhamento seguro de ativos digitais com parceiros/desenvolvedores externos e conectados internamente atrav&#233;s de APIs. Logo estas interfaces n&#227;o s&#227;o simplesmente conectores, mas um caminho de novas experi&#234;ncias, e a exemplo disso cito facilmente a Customer Experience.</p><p><strong>Em outras palavras, uma API &#233; como uma porta para os valiosos ativos digitais de uma empresa.&nbsp;</strong>Ela tem sido uma grande catalisadora<strong>&nbsp;</strong>da inova&#231;&#227;o e isso impactou na rela&#231;&#227;o empresa-cliente. A partir de suas funcionalidades nos deparamos com o fornecimento de um perfil mais preciso do consumidor e o resultado &#233; uma experi&#234;ncia do cliente com maior qualidade.</p><p>Nos &#250;ltimos anos tivemos um fomento dos canais de comunica&#231;&#227;o com os clientes, que hoje conseguem interagir com suas marcas por meio de lojas, voz, e-mail, aplicativos m&#243;veis, web ou chatbots. Logo o crescimento dos pontos de intera&#231;&#227;o tornou a jornada do cliente mais complexa, levando as empresas a considerar os dados desses canais para garantir uma experi&#234;ncia mais proveitosa poss&#237;vel.</p><p>Para fazer isso, as organiza&#231;&#245;es passaram a sincronizar dados entre os canais e fazer refer&#234;ncia cruzada dos dados. Isso s&#243; &#233; realizado atrav&#233;s de APIs, j&#225; que estas permitem um processamento de dados mais apurado.</p><p>&#201; essencial que as empresas consigam fazer esse acompanhamento do consumidor, que cada vez mais trafega de um dispositivo para outro em suas transa&#231;&#245;es. Por exemplo, um cliente liga para uma loja pedindo informa&#231;&#245;es sobre determinado produto, mas acaba fechando a compra por meio de um computador ou de um aplicativo. S&#227;o as APIs que permitem a coleta e transfer&#234;ncia de dados, ou seja, elas auxiliam na experi&#234;ncia personalizada do cliente.</p><p>Mas as facilidades n&#227;o v&#227;o apenas na dire&#231;&#227;o do consumidor, as APIs permitem que sua empresa realize a coleta de grande volume de dados de clientes como suas prefer&#234;ncias. A partir de tais informa&#231;&#245;es a empresa consegue criar um perfil mais detalhado do consumidor e assim oferecer ofertas especiais como incentivo a compra.</p><p>E n&#227;o pense que apenas empresas de grande porte podem melhorar suas opera&#231;&#245;es atrav&#233;s de APIs. Se voc&#234; possui uma empresa de pequeno ou m&#233;dio porte tamb&#233;m pode se beneficiar, seja a partir da exposi&#231;&#227;o de seus dados, do uso de APIs para acessar dados de fora da sua empresa ou uso de APIs para otimizar processos internos. Portanto, empresas que tomam a iniciativa de investirem em estrat&#233;gias de APIs implementadas conseguem:</p><ul><li><p>Melhorar os processos e fluxos de trabalho</p></li><li><p>Apresentar maior transpar&#234;ncia e visibilidade</p></li><li><p>Minimizar poss&#237;veis riscos</p></li><li><p>Impulsionar a inova&#231;&#227;o</p></li></ul><p>Al&#233;m disso, n&#227;o podemos nos esquecer da cereja do bolo: o relacionamento com o cliente, at&#233; porque toda empresa, independente do segmento ou tamanho, oferece produtos ou servi&#231;os a algu&#233;m. Por isso, aderir &#224;s estrat&#233;gias de APIs envolve:</p><ol><li><p>Dados em tempo real</p></li><li><p>Experi&#234;ncias relevantes</p></li><li><p>Ganho de valor</p></li><li><p>Mashup de experi&#234;ncias</p></li></ol><h3><strong>O desafio de uma boa Customer Experience</strong></h3><p>Com tudo o que foi dito neste artigo, fica claro que as APIs s&#227;o aliadas valiosas de qualquer organiza&#231;&#227;o que saiba como utiliz&#225;-las de maneira estrat&#233;gica, principalmente por que elas permitem que as organiza&#231;&#245;es analisem seus dados de forma mais operacional e real-time.</p><p>Ainda sim, h&#225; empresas que mant&#233;m um relacionamento com seus clientes pouco pr&#243;ximo, tratando-os como se nunca tivessem interagido antes. Como resultado temos a&#237; v&#225;rios pedidos e buscas de hist&#243;ricos de intera&#231;&#245;es anteriores. Algo que n&#227;o colabora em nada para o entrosamento entre empresa e consumidor.</p><p>O maior desafio para as empresas, que buscam evitar tais situa&#231;&#245;es, &#233; proporcionar aos seus clientes uma experi&#234;ncia cont&#237;nua, consistente e personalizada atrav&#233;s de uma an&#225;lise em tempo real de seus dados. Ter em m&#227;os informa&#231;&#245;es relevantes dos clientes ao longo dessa intera&#231;&#227;o permite tomadas de decis&#227;o mais acertadas, favorecendo a satisfa&#231;&#227;o e expectativas do cliente.</p><p>&#201; partindo desse desafio que uma boa estrat&#233;gia de APIs consegue n&#227;o s&#243; prever o comportamento de compra do cliente, mas tamb&#233;m de fazer sugest&#245;es mais adequadas aos seus desejos e necessidades atrav&#233;s do enriquecimento de informa&#231;&#245;es por terceiros.</p><p>De fato, APIs s&#227;o uma &#243;tima solu&#231;&#227;o para as necessidades do mercado quando falamos de experi&#234;ncia do cliente. O problema, como j&#225; mencionei, s&#227;o as organiza&#231;&#245;es que n&#227;o valorizam uma implementa&#231;&#227;o de estrat&#233;gias de APIs, fator vital em tempos de transforma&#231;&#227;o digital. &#201; preciso compreender que as APIs s&#227;o o elo que faltava entre os dados e experi&#234;ncia do consumidor.</p><p>&#201; na jun&#231;&#227;o das informa&#231;&#245;es coletadas, no uso de intelig&#234;ncia artificial e tabula&#231;&#245;es cruzadas que encontramos um refinamento na constru&#231;&#227;o do perfil do consumidor e este tem, no fim das contas, uma experi&#234;ncia muito mais fluida e relevante com sua empresa.</p>]]></content:encoded></item><item><title><![CDATA[Aumente o uso de suas APIs com estas dicas fundamentais]]></title><description><![CDATA[O sucesso de suas APIs, independente do p&#250;blico principal ser t&#233;cnico ou de neg&#243;cio passa por uma documenta&#231;&#227;o bem elaborada, transmitindo seu valor ao neg&#243;cio de forma clara e sua utiliza&#231;&#227;o acess&#237;vel, ajuda novos usu&#225;rios a compreender as suas aplica&#231;&#245;es e reduz o impacto na entrega e, consequentemente, o custo de implementa&#231;&#227;o e suporte.]]></description><link>https://www.apiplaybook.com/p/aumente-o-uso-de-suas-apis-com-estas-dicas-fundamentais</link><guid isPermaLink="false">https://www.apiplaybook.com/p/aumente-o-uso-de-suas-apis-com-estas-dicas-fundamentais</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Tue, 12 May 2020 14:19:16 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/8a858bcc-0770-4399-a687-4cdbe4cbb25b_1600x1052.png" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!alXC!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!alXC!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 424w, https://substackcdn.com/image/fetch/$s_!alXC!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 848w, https://substackcdn.com/image/fetch/$s_!alXC!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 1272w, https://substackcdn.com/image/fetch/$s_!alXC!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!alXC!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/d0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;Aumente o uso de suas APIs com estas dicas fundamentais&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="Aumente o uso de suas APIs com estas dicas fundamentais" title="Aumente o uso de suas APIs com estas dicas fundamentais" srcset="https://substackcdn.com/image/fetch/$s_!alXC!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 424w, https://substackcdn.com/image/fetch/$s_!alXC!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 848w, https://substackcdn.com/image/fetch/$s_!alXC!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 1272w, https://substackcdn.com/image/fetch/$s_!alXC!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fd0e1f2d8-42ba-4955-83de-4aeb6f72e4a0_1600x1052.png 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a></figure></div><p>O sucesso de suas APIs, independente do p&#250;blico principal ser t&#233;cnico ou de neg&#243;cio passa por uma documenta&#231;&#227;o bem elaborada, transmitindo seu valor ao neg&#243;cio de forma clara e sua utiliza&#231;&#227;o acess&#237;vel, ajuda novos usu&#225;rios a compreender as suas aplica&#231;&#245;es e reduz o impacto na entrega e, consequentemente, o custo de implementa&#231;&#227;o e suporte.</p><p>Quando o assunto &#233; API, sua documenta&#231;&#227;o &#233; um dos elementos principais para que esta tenha sucesso. Trata-se da entrega t&#233;cnica de todo conte&#250;do, ou seja, um manual de refer&#234;ncia com instru&#231;&#245;es de como realizar uma integra&#231;&#227;o efetiva da API, al&#233;m de pormenores a respeito das suas fun&#231;&#245;es, tipos de retorno, argumentos e exemplos de uso.</p><p>Logo uma API bem documentada:</p><ul><li><p>Deixa claro o seu benef&#237;cio do ponto de vista de neg&#243;cio;</p></li><li><p>Aperfei&#231;oa a Developer Experience;</p></li><li><p>Previne manuten&#231;&#245;es;</p></li><li><p>Torna o usu&#225;rio consciente do papel da API;</p></li><li><p>Favorece e acelera o processo de integra&#231;&#227;o;</p></li><li><p>Ajuda no planejamento de or&#231;amento, cronograma e lan&#231;amento de novos produtos.</p></li></ul><p>Todo desenvolvedor precisa compreender que suas APIs podem ser utilizadas por terceiros, que apresentam vis&#227;o de neg&#243;cios diferentes e conhecimentos t&#233;cnicos superiores ou inferiores. Dessa forma, a boa documenta&#231;&#227;o de API &#233; o melhor caminho para que qualquer outro desenvolvedor consiga compreend&#234;-la e a utilize corretamente.</p><p>Quando explicativa, a documenta&#231;&#227;o permite que desenvolvedores priorizem seu tempo e a for&#231;a de trabalho durante processo de integra&#231;&#227;o da API. Por outro lado, uma documenta&#231;&#227;o inadequada acarreta em barreiras para a disponibiliza&#231;&#227;o e uso da API, uma vez que pode provocar adversidades relacionadas &#224; excedentes or&#231;ament&#225;rios n&#227;o previstos e contratempos de suporte. Ademais, quanto maior a clareza e objetividade presente na documenta&#231;&#227;o, melhor e mais longo ser&#225; o ciclo de vida da API.</p><h3><strong>A import&#226;ncia de uma boa documenta&#231;&#227;o</strong></h3><p>O desenvolvimento de uma estrat&#233;gia de API p&#250;blica envolve a constru&#231;&#227;o de um ecossistema em torno dela e, consequentemente, passa pela documenta&#231;&#227;o, onde seu principal objetivo &#233; obter a maior quantidade de desenvolvedores conhecendo-as e implementando as com uma boa experi&#234;ncia. Por isso o mais indicado e correto &#233; que n&#227;o se pule nenhuma etapa na cria&#231;&#227;o da documenta&#231;&#227;o, evitando assim o risco de perder potenciais usu&#225;rios.</p><h3><strong>A seguir as 10 dicas fundamentais para uma documenta&#231;&#227;o de&nbsp;sucesso:</strong></h3><h4><strong>1. Elabore uma documenta&#231;&#227;o completa</strong></h4><p>A documenta&#231;&#227;o acessada pelos desenvolvedores deve apresentar um conte&#250;do que auxilie durante toda a intera&#231;&#227;o do usu&#225;rio com a API, por isso &#233; essencial uma aten&#231;&#227;o especial e detalhada de todos os dados. &#201; importante tamb&#233;m destacar as implica&#231;&#245;es no seu uso e com isso o usu&#225;rio entender&#225; mais sobre a estabilidade da API no momento da integra&#231;&#227;o.</p><h4><strong>2. Apresente a lista de recursos dispon&#237;veis</strong></h4><p>Os m&#233;todos e dados dispon&#237;veis s&#227;o itens b&#225;sicos de toda documenta&#231;&#227;o de APIs. Elaborar essa lista &#233; um dos primeiros passos envolvendo esse documento. Por isso descreva detalhadamente a fun&#231;&#227;o de cada m&#233;todo, par&#226;metros de entrada e sa&#237;da. Afinal de contas tal lista ser&#225; uma das principais refer&#234;ncias para que desenvolvedores possam tra&#231;ar um plano de integra&#231;&#227;o da API.</p><p><strong>Exemplo:</strong> <a href="https://www.instagram.com/developer/endpoints/">Instagram</a></p><h4><strong>3. Disponibilize exemplos</strong></h4><p>Mostre exemplos de c&#243;digo para que outros desenvolvedores possam fazer a liga&#231;&#227;o entre conceito que voc&#234; transmite e a aplica&#231;&#227;o pr&#225;tica da API.</p><h4><strong>4.&nbsp;Reforce os dados sobre autentica&#231;&#227;o</strong></h4><p>Reforce em todas as p&#225;ginas da documenta&#231;&#227;o as etapas e informa&#231;&#245;es necess&#225;rias para consumi-las. Por mais que pare&#231;a repetitivo, reforce sempre que poss&#237;vel, como por exemplo, processo de autentica&#231;&#227;o, passos obrigat&#243;rios, cadastro para gera&#231;&#227;o de chaves de acesso e etc.</p><h4><strong>5. Fique atento aos C&#243;digos de Erro/HTTP Status</strong></h4><p>Outro integrante importante da documenta&#231;&#227;o s&#227;o os c&#243;digos de erro ou mensagens de HTTP status da API. Os HTTP Status Codes possuem um padr&#227;o, mas o mesmo n&#227;o ocorre no caso de c&#243;digos de erros. Utilize o espa&#231;o da documenta&#231;&#227;o para detalhar todas as possibilidades de problemas e erros com os quais o desenvolvedor pode se deparar ao trabalhar com a sua API. Uma escolha interessante &#233; evitar mensagens de erro gen&#233;ricas e optar por mensagens mais explicativas.</p><p><strong>Exemplos:</strong> <a href="https://developer.twitter.com/en/docs/basics/response-codes">Twitter </a>e <a href="https://docs.aws.amazon.com/AmazonSimpleDB/latest/DeveloperGuide/APIError.html">AWS</a></p><h4><strong>6. Invista em documenta&#231;&#227;o interativa</strong></h4><p>Permitir que haja intera&#231;&#227;o dos usu&#225;rios com sua API atrav&#233;s da documenta&#231;&#227;o &#233; uma &#243;tima forma de tornar a experi&#234;ncia mais din&#226;mica e as integra&#231;&#245;es mais r&#225;pidas. Al&#233;m da documenta&#231;&#227;o est&#225;tica e descritiva, invista em uma mais din&#226;mica por meio de servi&#231;os como o Swagger, no qual o desenvolvedor consegue autenticar, verificar m&#233;todos e fazer chamadas em tempo real, com retornos de sa&#237;da e c&#243;digos de erro.</p><h4><strong>7. Teste sua documenta&#231;&#227;o</strong></h4><p>&#201; necess&#225;rio coer&#234;ncia e dados concretos presentes na documenta&#231;&#227;o de uma API, por esse motivo teste tudo o que foi documentado sobre sua API e de prefer&#234;ncia com o aux&#237;lio de uma equipe de desenvolvedores que n&#227;o elaborou a cria&#231;&#227;o dela, assim voc&#234; ter&#225; a sua disposi&#231;&#227;o diferentes olhares daqueles j&#225; presentes no projeto.</p><h4><strong>8. Permita a experimenta&#231;&#227;o an&#244;nima da&nbsp;API</strong></h4><p>Essa &#233; uma maneira de autorizar que outras pessoas tenham a chance de testar sua API de forma r&#225;pida e intuitiva, por meio de uma interface web. A vantagem disso &#233; que n&#227;o h&#225; necessidade de instalar nada. Com explora&#231;&#227;o de API, usu&#225;rios com menor conhecimento t&#233;cnico podem brincar com sua API e explorar seus dados.</p><p>Outra quest&#227;o da explora&#231;&#227;o &#233; dar permiss&#227;o para clientes em potencial possam experiment&#225;-la sem precisar se cadastrar ou passar por um processo burocr&#225;tico. O engajamento &#233; consideravelmente maior nessa situa&#231;&#227;o. &#201; poss&#237;vel tamb&#233;m oferecer um ambiente de sandbox, j&#225; que ele &#233; relativamente simples e pode ajudar os desenvolvedores a conhecer visualmente o valor de sua API.</p><p><strong>Exemplo: </strong><a href="https://desenvolvedores.catho.com.br/api-portal/swagger">Catho</a></p><h4><strong>9. Limitando a quantidade de requisi&#231;&#245;es</strong></h4><p>Outro elemento de relev&#226;ncia na documenta&#231;&#227;o &#233; a quantidade de chamadas dispon&#237;veis. Esse n&#250;mero pode variar no caso da monetiza&#231;&#227;o de APIs, por exemplo voc&#234; possui uma parceria com uma empresa ou desenvolvedor e nesse caso eles possuem mais chamadas que um usu&#225;rio comum. De modo geral, tais informa&#231;&#245;es precisam ser claras e de f&#225;cil acesso, da mesma forma que a mensagem de erro que aparecer&#225; para o usu&#225;rio se este ultrapassar o limite permitido</p><h4><strong>10. Estruturas, m&#233;todos de&nbsp;URI</strong></h4><p>A estrutura e os m&#233;todos de cada URI na API devem ser documentados. Isso precisa ser realizado de tal maneira que o usu&#225;rio tenha acesso a descri&#231;&#245;es detalhadas de todas as fun&#231;&#245;es dispon&#237;veis. Obviamente nem tudo a respeito de um endpoint pode ou deve constar na documenta&#231;&#227;o, isso nos casos em que o usu&#225;rio n&#227;o tenha os direitos necess&#225;rios para usar tais endpoints.</p><p>Uma forma de exemplificar isso &#233; atrav&#233;s de dois segmentos de APIs: as gratuitas e as dispon&#237;veis apenas para usu&#225;rios business-to-business ou monetizados. No caso da primeira, &#233; poss&#237;vel que algumas fun&#231;&#245;es, por serem restritas, n&#227;o estejam dispon&#237;veis para um usu&#225;rio comum. Dessa forma, a documenta&#231;&#227;o desse endpoint n&#227;o deve ser oferecida para algu&#233;m sem autoriza&#231;&#227;o.</p><h3><strong>Os benef&#237;cios de uma documenta&#231;&#227;o de APIs bem implementada</strong></h3><p>Dentre todas as fases do ciclo de vida da API, a documenta&#231;&#227;o &#233; uma das mais importantes. Ficar atento a todos os elementos que devem constar no documento &#233; essencial para colher os frutos de uma API bem sucedida.</p><p>Saber documentar uma API implica nos seguintes benef&#237;cios:</p><ul><li><p><strong>Ado&#231;&#227;o de mais APIs</strong></p></li></ul><p>Os padr&#245;es de ado&#231;&#227;o j&#225; n&#227;o s&#227;o mais os mesmos para os desenvolvedores. A elabora&#231;&#227;o de uma boa documenta&#231;&#227;o de API est&#225; diretamente correlacionada a ado&#231;&#227;o de APIs. Se voc&#234; oferecer uma documenta&#231;&#227;o clara e acess&#237;vel, mais usu&#225;rios encontrar&#227;o valor em seus servi&#231;os, levando a um crescimento e ado&#231;&#227;o de mais APIs</p><ul><li><p><strong>Maior conscientiza&#231;&#227;o</strong></p></li></ul><p>Quando muitas pessoas utilizam um produto ou servi&#231;o tornando-o valioso trata-se do efeito de rede. O mesmo vale para os consumidores de sua API. Quanto mais satisfeitos eles estiverem, com mais afinco eles defenderam seus servi&#231;os e assim ser&#225; poss&#237;vel prever um crescimento no evangelismo e na publicidade boca a boca.</p><ul><li><p><strong>Manuten&#231;&#227;o e atualiza&#231;&#245;es mais f&#225;ceis</strong></p></li></ul><p>Quanto mais detalhada e precisa for a documenta&#231;&#227;o melhor ser&#225; a manuten&#231;&#227;o e atualiza&#231;&#227;o das APIs. Com isso as equipes internas ter&#227;o em m&#227;os mais detalhes sobre os recursos, m&#233;todos, solicita&#231;&#245;es e respostas associadas.</p><h3><strong>Saiba como apresentar as informa&#231;&#245;es</strong></h3><p>Apesar da significativa import&#226;ncia da documenta&#231;&#227;o de APIs, ela ainda &#233; vista por muitas empresas como um item &#8220;opcional&#8221; e acaba sendo deixada de lado, especialmente quando o time de desenvolvedores mant&#233;m a documenta&#231;&#227;o manualmente a cada lan&#231;amento de novas vers&#245;es.</p><p>&#201; preciso levar em conta o que uma boa documenta&#231;&#227;o pode proporcionar como melhora na Developer Experience e aumento nas chances de consumir a API, dado que os usu&#225;rios encontrar&#227;o valor em seus servi&#231;os com facilidade.</p><h4><strong>Confira 3 exemplos de empresas que realizam documenta&#231;&#227;o de suas&nbsp;APIs:</strong></h4><ol><li><p><a href="https://docs.pagar.me/reference#criar-transacao">Pagar.me</a></p></li><li><p><a href="https://dev.elo.com.br/apis?lng=pt">ELO</a></p></li><li><p><a href="https://www.twilio.com/docs">Twilio</a></p></li></ol><p>Vale destacar que muitas das pessoas que trabalham com APIs n&#227;o possuem necessariamente um conhecimento aprofundado do assunto ou mesmo domine os jarg&#245;es comuns no setor, portanto, escreva de maneira simples, permitindo a compreens&#227;o tanto de desenvolvedores como tamb&#233;m de tomadores de decis&#227;o, ou seja, os n&#227;o t&#233;cnicos.</p><p>A produ&#231;&#227;o de v&#237;deos, webinars e tutoriais s&#227;o muito mais explicativos do que documenta&#231;&#245;es extensas, portanto, por mais que o custo seja mais elevado e dificulte a sua realiza&#231;&#227;o constante conforme as APIs s&#227;o atualizadas, o investimento se paga facilmente dado a simplicidade de consumo por parte do desenvolvedor ou agente de neg&#243;cio.</p>]]></content:encoded></item><item><title><![CDATA[Conheça as 3 principais ferramentas de documentação de APIs]]></title><description><![CDATA[Engajar desenvolvedores &#233; fundamental para uma API de sucesso.]]></description><link>https://www.apiplaybook.com/p/conheca-as-3-principais-ferramentas-de-documentacao-de-apis</link><guid isPermaLink="false">https://www.apiplaybook.com/p/conheca-as-3-principais-ferramentas-de-documentacao-de-apis</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Tue, 12 May 2020 14:17:52 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/c8ab9936-37cb-4127-ae5a-befe6d495e7b_1280x853.png" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!g2EN!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!g2EN!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 424w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 848w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 1272w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!g2EN!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/e8780534-107e-4aad-9f52-002355e0f807_1280x853.png&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:&quot;Conhe&#231;a as 3 principais ferramentas de documenta&#231;&#227;o de&nbsp;APIs&quot;,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="Conhe&#231;a as 3 principais ferramentas de documenta&#231;&#227;o de&nbsp;APIs" title="Conhe&#231;a as 3 principais ferramentas de documenta&#231;&#227;o de&nbsp;APIs" srcset="https://substackcdn.com/image/fetch/$s_!g2EN!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 424w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 848w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 1272w, https://substackcdn.com/image/fetch/$s_!g2EN!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fe8780534-107e-4aad-9f52-002355e0f807_1280x853.png 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">None</figcaption></figure></div><p>Engajar desenvolvedores &#233; fundamental para uma API de sucesso. Boa parte disso se deve a documenta&#231;&#227;o bem elaborada. Se uma API n&#227;o for documentada adequadamente, muito provavelmente o usu&#225;rio gastar&#225; seu tempo tentando entender o seu funcionamento, o que acaba criando barreiras no uso do servi&#231;o.</p><p>Um dos focos deste documento s&#227;o os recursos e endpoints disponibilizados e &#233; preciso lembrar que n&#227;o basta apresentar algumas p&#225;ginas HTML sobre varia&#231;&#245;es de retorno, como realizar autentica&#231;&#227;o e o qual a fun&#231;&#227;o de cada recurso. A documenta&#231;&#227;o de APIs vai al&#233;m destes requisitos b&#225;sicos, mas precisa oferecer uma experi&#234;ncia mais visual e interativa da API, ou seja, proporcionando um teste em tempo real delas.</p><p>No mercado podem ser encontradas diversas ferramentas para auxiliar na elabora&#231;&#227;o de uma boa documenta&#231;&#227;o interativa para os recursos da sua API.</p><p><strong>Atualmente tr&#234;s especifica&#231;&#245;es se destacam entre as demais:</strong></p><ol><li><p><strong><a href="https://swagger.io/solutions/api-documentation/">Swagger</a></strong></p></li><li><p><strong><a href="https://apiblueprint.org/documentation/tutorial.html">API Blueprint</a></strong></p></li><li><p><strong><a href="https://raml.org/developers/document-your-api">RAML</a></strong></p></li></ol><p>Cada uma das ferramentas acima apresenta foco em diferentes aspectos como legibilidade, design, curva de aprendizado, integra&#231;&#227;o com outros servi&#231;os. A seguir vamos entender suas particularidades:</p><h3><strong>Tornando sua documenta&#231;&#227;o mais intuitiva com&nbsp;Swagger</strong></h3><p>Entre os diversos formatos de descri&#231;&#227;o de APIs que geram a documenta&#231;&#227;o dinamicamente, o mais conhecido &#233; o Swagger. Ele &#233; de c&#243;digo aberto e permite que desenvolvedores e equipes projetem, construam, documentem e consumam APIs em RESTful. Atualmente se encontra em sua vers&#227;o 2.0.</p><p>Trata-se de uma ferramenta padr&#227;o de mercado, cujo objetivo &#233; possibilitar que a documenta&#231;&#227;o evolua juntamente com a implementa&#231;&#227;o da API, uma vez que a documenta&#231;&#227;o pode ser gerada automaticamente. Grandes empresas de tecnologia como Amazon, Netflix, Apigee, Getty Images, Microsoft e Paypal j&#225; adotam Swagger em seus produtos e projetos, principalmente em fun&#231;&#227;o da facilidade de integra&#231;&#227;o com o c&#243;digo fonte.</p><p>Na hora de descrever a API &#233; preciso que os arquivos sejam criados no formato JSON. Se por um lado isso facilita o trabalho de programadores, por outro pode ser algo complexo demais para algu&#233;m que n&#227;o esteja t&#227;o envolvido com o c&#243;digo.</p><p><strong>O Swagger &#233; capaz de ajudar desenvolvedores de APIs REST a:</strong></p><ul><li><p>Modelar APIs;</p></li><li><p>Gerar documenta&#231;&#227;o automatizada da API;</p></li><li><p>Gerar c&#243;digos do cliente e do servidor, suportando diversas linguagens de programa&#231;&#227;o;</p></li><li><p>Testar funcionalidades da API.</p></li></ul><p>Para realizar tais tarefas o Swagger precisa especificar a OpenAPI, uma linguagem para descrever contratos de APIs REST. Ela delimita um formato JSON com campos padronizados para que o usu&#225;rio consiga descrever recursos, modelo de dados, URIs, Content-Types e m&#233;todos HTTP aceitos&nbsp;.</p><p>Al&#233;m da OpenAPI, <strong>o Swagger disp&#245;e um conjunto de ferramentas e as principais s&#227;o:</strong></p><ul><li><p>Swagger Editor</p></li><li><p>Swagger UI</p></li><li><p>Swagger Codegen</p></li></ul><p>O m&#243;dulo de UI permite que desenvolvedores interajam intuitivamente com as APIs em sandbox. J&#225; o Editor &#233; uma ferramenta online que possibilita documentar de forma mais interativa usando YAML. Um dos benef&#237;cios do Editor &#233; seu portf&#243;lio contendo templates de documentos que servem de base para quem n&#227;o deseja iniciar do &#8220;zero&#8221; a documenta&#231;&#227;o.</p><p>Al&#233;m disso, uma de suas principais fun&#231;&#245;es do Editor &#233; de que ao iniciar um novo projeto o usu&#225;rio pode definir a toda a estrutura de sua API e assim gerar o c&#243;digo em uma linguagem de sua prefer&#234;ncia</p><p>Quanto ao Swagger Codegen, a partir da descri&#231;&#227;o em YAML cria automaticamente o &#8220;esqueleto&#8221; da API com documenta&#231;&#227;o em diferentes linguagens de programa&#231;&#227;o.</p><p>A documenta&#231;&#227;o para APIs pode ser feita de tr&#234;s formas:</p><ol><li><p><strong>Manualmente:</strong> o desenvolvedor escreve livremente as especifica&#231;&#245;es da API e as publica posteriormente em seu pr&#243;prio servidor.</p></li><li><p><strong>Automaticamente</strong>: simultaneamente ao desenvolvimento da API &#233; gerada a documenta&#231;&#227;o.</p></li><li><p><strong>Codegen</strong>: converte todas as anota&#231;&#245;es contidas no c&#243;digo fonte das APIs REST em documenta&#231;&#227;o</p></li></ol><p>A documenta&#231;&#227;o interativa da API por meio do Swagger ainda inclui endpoints da API REST que detalham payloads, cabe&#231;alhos, par&#226;metros, m&#233;todos HTTP necess&#225;rios para solicita&#231;&#245;es e informa&#231;&#245;es de c&#243;digo de erro.</p><p>Vale lembrar que investir em uma documenta&#231;&#227;o mais interativa com o Swagger traz vantagens para o desenvolvedor que deseje futuramente consumir sua API, pois ele torna a integra&#231;&#227;o desta mais r&#225;pida e de maior qualidade.</p><h3><strong>A facilidade de leitura do API Blueprint</strong></h3><p>Trata-se de uma linguagem de descri&#231;&#227;o e especifica&#231;&#227;o de APIs baseada em Markdown, o que facilita a edi&#231;&#227;o dos materiais por usu&#225;rios que n&#227;o est&#227;o familiarizados com c&#243;digos. A maior parte de suas ferramentas s&#227;o open source, j&#225; que seu intuito &#233; garantir que o desenvolvedor consiga projetar e criar prot&#243;tipos de APIs em menos tempo, al&#233;m de documentar e testar as APIs de miss&#227;o cr&#237;tica j&#225; implantadas.</p><p>Sua sintaxe &#233; simples e concisa, mas ainda sim expressiva, permitindo que ela seja acess&#237;vel a todos os envolvidos no ciclo de vida de uma API.</p><p>H&#225; outros padr&#245;es muito conhecidos no mercado como o Swagger, mencionado acima, por&#233;m a curva de aprendizagem da API Blueprint &#233; mais r&#225;pida. Quanto a leitura ela &#233; f&#225;cil, pois as se&#231;&#245;es s&#227;o bem definidas e agrupadas por rota, sendo que cada rota pode apresentar v&#225;rios m&#233;todos HTTP diferentes com nomes associados a cada m&#233;todo</p><p>A documenta&#231;&#227;o nesse caso mostra:</p><ul><li><p>Atributos listados com suas descri&#231;&#245;es</p></li><li><p>Exemplos de solicita&#231;&#245;es</p></li><li><p>Respostas desses exemplos</p></li></ul><p>No caso do Blueprint, duas s&#227;o as ferramentas integradas a ele que se destacam:</p><ol><li><p><strong>Dredd</strong></p></li></ol><p>Permite que o servi&#231;o de back-end seja testado com base na documenta&#231;&#227;o da API. Dessa forma os problemas de atualiza&#231;&#227;o da documenta&#231;&#227;o em quest&#227;o podem ser resolvidos. A ferramenta &#233; capaz de suportar linguagens como PHP, Python, Ruby, Perl, Node.js ou Go</p><ol><li><p><strong>Drakov</strong></p></li></ol><p>Permite que servi&#231;os simulados sejam iniciados e testados com solicita&#231;&#245;es/respostas adaptadas &#224; documenta&#231;&#227;o da API, o que pode ser visto como uma banco de ensaio.</p><h3><strong>RAML: de desenvolvedores para desenvolvedores</strong></h3><p>Trata-se de um acr&#244;nimo para RESTful API Modeling Language, logo RAML &#233; uma linguagem para descrever explicitamente API RESTful. Al&#233;m de tornar mais f&#225;cil o gerenciamento do ciclo de vida da API, o RAML &#233; conciso e faz a legibilidade da API mais amig&#225;vel ao ser humano.</p><p>Para documentar sua API com RAML, voc&#234; pode optar por ferramentas open source como o Console da API ou o HTML RAML 2. A documenta&#231;&#227;o pode ser gerada rapidamente, sendo que os analisadores dispon&#237;veis em v&#225;rios idiomas permitem que a cria&#231;&#227;o de documentos personalizados e scripts interativos, como Spotify.</p><p>O RAML tem como formato base o YAML, mas tamb&#233;m &#233; amplamente desenvolvido com base em outros padr&#245;es como JSON e &#233; neutro com ferramentas de linguagem como Java, Javascript,&nbsp;.Net, PHP, Python, Ruby.</p><p>No caso do YAML, n&#227;o se trata de uma linguagem de marca&#231;&#227;o, mas de uma para realizar a descri&#231;&#227;o de dados de maneira leg&#237;vel para desenvolvedores. Tal descri&#231;&#227;o, por ser muito utilizada por desenvolvedores facilita a compreens&#227;o do RAML, que suporta muitas pr&#225;ticas de reutiliza&#231;&#227;o e ajuda na cria&#231;&#227;o de sua documenta&#231;&#227;o a partir de pequenos blocos de constru&#231;&#227;o.</p><p>Apesar disso, optar pelo RAML possui algumas desvantagens como ser destinado a APIs RESTful, dessa forma se sua Web API n&#227;o seguir os mesmos princ&#237;pios &#233; poss&#237;vel que voc&#234; n&#227;o consiga usar o RAML adequadamente. Tal qual o API Blueprint, ele n&#227;o se ajusta bem no caso de APIs n&#227;o HTTP.</p><p>Outro ponto que se deve ter aten&#231;&#227;o &#233; quanto a linguagem. O YAML &#233; direcionado para desenvolvedores, ou seja, se este n&#227;o utilizar uma ferramenta de design para criar a API ou a documenta&#231;&#227;o, a equipe sem conhecimentos t&#233;cnicos poder&#225; ter dificuldades.</p><h3><strong>Documenta&#231;&#227;o constantemente atualizadas</strong></h3><p>Como voc&#234; pode ver as tr&#234;s ferramentas que citei acima s&#227;o bons exemplos para manter sua API com um bom n&#237;vel de documenta&#231;&#227;o. Uma dica valiosa &#233; se preocupar com este aspecto&#8202;&#8212;&#8202;a documenta&#231;&#227;o&#8202;&#8212;&#8202;logo na concep&#231;&#227;o da API, assim o desenvolvimento e documenta&#231;&#227;o podem caminhar juntos.</p><p>Em qualquer cen&#225;rio, a aus&#234;ncia de material pode representar um afastamento de usu&#225;rios em potencial. O lado bom &#233; que hoje podemos contar com frameworks de documenta&#231;&#227;o de APIs automatizados. As ferramentas mencionadas&#8202;&#8212;&#8202;Swagger, API Blueprint e RAML&#8202;&#8212;&#8202;apresentam recursos para criar automaticamente a documenta&#231;&#227;o para todo o ciclo de vida de sua API.</p><p>Entretanto documentar por si s&#243; atrav&#233;s dessas ferramentas n&#227;o &#233; o suficiente. &#201; necess&#225;rio que voc&#234; como desenvolvedor mantenha seu trabalho atualizado, evitando documenta&#231;&#245;es pobres ou obsoletas. Isso por que as APIs s&#227;o modificadas a cada bug resolvido e nova funcionalidade s&#227;o adicionada, ou seja, documentar sua API com as ferramentas corretas e regularmente atualizar o documento garante uma melhor comunica&#231;&#227;o para todos os envolvidos no produto.</p>]]></content:encoded></item><item><title><![CDATA[Não explore, fortaleça o ecossistema]]></title><description><![CDATA[Neste artigo compartilho com voc&#234;s algumas dicas importantes de como a sua empresa pode se conectar e fortalecer corretamente ecossistemas&#8230;]]></description><link>https://www.apiplaybook.com/p/nao-explore-fortaleca-o-ecossistema-77a634c9954e</link><guid isPermaLink="false">https://www.apiplaybook.com/p/nao-explore-fortaleca-o-ecossistema-77a634c9954e</guid><dc:creator><![CDATA[David Ruiz]]></dc:creator><pubDate>Wed, 02 May 2018 21:44:21 GMT</pubDate><enclosure url="https://substack-post-media.s3.amazonaws.com/public/images/6dfc8c90-dd4a-4489-be6f-cef2bf28aeda_800x224.png" length="0" type="image/jpeg"/><content:encoded><![CDATA[<div class="captioned-image-container"><figure><a class="image-link image2" target="_blank" href="https://substackcdn.com/image/fetch/$s_!B0C9!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png" data-component-name="Image2ToDOM"><div class="image2-inset"><picture><source type="image/webp" srcset="https://substackcdn.com/image/fetch/$s_!B0C9!,w_424,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 424w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_848,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 848w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_1272,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 1272w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_1456,c_limit,f_webp,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 1456w" sizes="100vw"><img src="https://substackcdn.com/image/fetch/$s_!B0C9!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png" data-attrs="{&quot;src&quot;:&quot;https://substack-post-media.s3.amazonaws.com/public/images/4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png&quot;,&quot;srcNoWatermark&quot;:null,&quot;fullscreen&quot;:null,&quot;imageSize&quot;:null,&quot;height&quot;:null,&quot;width&quot;:null,&quot;resizeWidth&quot;:null,&quot;bytes&quot;:null,&quot;alt&quot;:null,&quot;title&quot;:null,&quot;type&quot;:null,&quot;href&quot;:null,&quot;belowTheFold&quot;:false,&quot;topImage&quot;:true,&quot;internalRedirect&quot;:null,&quot;isProcessing&quot;:false,&quot;align&quot;:null,&quot;offset&quot;:false}" class="sizing-normal" alt="" srcset="https://substackcdn.com/image/fetch/$s_!B0C9!,w_424,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 424w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_848,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 848w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_1272,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 1272w, https://substackcdn.com/image/fetch/$s_!B0C9!,w_1456,c_limit,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F4d34386a-46e7-4f2f-ab0a-bdf578f72811_800x224.png 1456w" sizes="100vw" fetchpriority="high"></picture><div></div></div></a><figcaption class="image-caption">Lan&#231;amento do ONOVOLAB, centro de co-inova&#231;&#227;o patrocinado pela Cart&#227;o Elo, Roche e Algar Telecom em S&#227;o Carlos,&nbsp;SP.</figcaption></figure></div><p><em>Neste artigo compartilho com voc&#234;s algumas dicas importantes de como a sua empresa pode se conectar e fortalecer corretamente ecossistemas existentes.</em></p><p>Diferente de quando comecei a trabalhar como volunt&#225;rio h&#225; onze anos, hoje muito se fala sobre ecossistema como um todo, n&#227;o s&#243; sobre desenvolvimento, mas tamb&#233;m de empreendedorismo e de inova&#231;&#227;o. Empresas, em especial as de grande porte, patrocinam n&#227;o s&#243; grandes eventos, mas tamb&#233;m promovem encontros, hackathons e desafios. At&#233; aqui tudo bem, o problema est&#225; em <strong>como </strong>estas empresas est&#227;o conduzindo estas iniciativas, onde acabam confundindo <strong>voluntariado com explora&#231;&#227;o</strong>. Alimenta&#231;&#227;o barata com <strong>prototipa&#231;&#227;o gratuita</strong>.</p><h3>Fortale&#231;a iniciativas existentes</h3><p>A melhor forma de iniciar o relacionamento de uma empresa com os ecossistemas existentes &#233; atrav&#233;s do patroc&#237;nio e incentivo. Isto porque a grande maioria dos ecossistemas s&#227;o formados por grupos e comunidades de pessoas que atuam de forma volunt&#225;ria. Volunt&#225;rios ativos no mercado de trabalho que dedicam parte do seu tempo livre para compartilhar conhecimento atrav&#233;s de artigos e postagens em grupos de discuss&#227;o online, ou atrav&#233;s de pequenos eventos (conhecidos como meetups) ou at&#233; mesmo em eventos de m&#233;dio e grande porte.</p><p>Diferente do que possa parecer, o investimento &#233; muito pequeno comparado com o impacto positivo gerado. Para a empresa que patrocina, o principal retorno &#233; o relacionamento com os l&#237;deres destes grupos e comunidades, que ser&#227;o bem &#250;teis para conectar seu neg&#243;cio com a audi&#234;ncia, em especial validando seu produto/servi&#231;o, ou at&#233; mesmo para a contrata&#231;&#227;o de novos colaboradores.</p><p>Recomendo tr&#234;s tipos de a&#231;&#245;es:</p><ol><li><p><strong>Eventos menores, meetups e workshops:</strong> Muitas vezes os grupos/comunidades nem precisam de dinheiro diretamente, mas apenas de apoio ao oferecer um local para realizar o encontro, com infraestrutura e alimenta&#231;&#227;o adequados. Dependendo do meetup, o dinheiro &#233; necess&#225;rio para uma produ&#231;&#227;o mais profissional e tamb&#233;m para o deslocamento de alguns membros e palestrantes.</p></li><li><p><strong>Grandes eventos (Ex: <a href="https://endeavor.org.br/">Endeavor</a>, <a href="https://case.abstartups.com.br/">CASE</a>, <a href="http://brasil.campus-party.org/">Campus Party</a>, <a href="https://imasters.com.br/">iMasters</a> e <a href="http://www.thedevelopersconference.com.br/">The Developers Conference</a>): </strong>Grandes eventos oferecem uma estrutura bem organizada para os patrocinadores, desde pacotes de m&#237;dia como tamb&#233;m todo o suporte para realizar a&#231;&#245;es antes e durante o evento. O investimento &#233; maior comparado a minha primeira sugest&#227;o, por&#233;m, s&#243; o retorno de m&#237;dia tende a pagar o investimento realizado.</p></li><li><p><strong>Espa&#231;os f&#237;sicos (Ex; <a href="https://www.facebook.com/onovolab/">ONOVOLAB</a>, <a href="http://developerhub.com.br/">Developer Hub&#8202;&#8212;&#8202;iMasters</a> e <a href="https://www.wework.com/pt-BR/">WeWork</a>): </strong>O investimento em espa&#231;os f&#237;sicos tende a ser maior que as duas sugest&#245;es anteriores, por&#233;m, a presen&#231;a da marca ser&#225; fixa e ocorrer&#225; ao longo do ano, bem como a oportunidade de engajamento com o p&#250;blico. Vale ressaltar que este apoio permite com que outras atividades (eventos/meetups/hackathons) aconte&#231;am no espa&#231;o e, em muitas vezes de participa&#231;&#227;o gratuita.</p></li></ol><h3>Crie conex&#245;es e promova a organiza&#231;&#227;o</h3><p>Ao firmar um patroc&#237;nio dentre as sugest&#245;es anteriores, a empresa normalmente ter&#225; a oportunidade de se apresentar para a audi&#234;ncia. Muito cuidado aqui para n&#227;o &#8220;fazer jab&#225;&#8221;. Diferente de audi&#234;ncias tradicionais, aqui ela tende a ir embora ou simplesmente ignorar o que est&#225; sendo dito se o discurso for muito &#8220;gen&#233;rico&#8221; ou &#8220;vendedor&#8221;. Aproveite esta oportunidade para ser transparente e sincero. Deixe claro os interesses da empresa e convide para que a audi&#234;ncia conecte-se com os colaboradores presentes. Crie um canal de comunica&#231;&#227;o direto. Isso ser&#225; fundamental ao longo do relacionamento.</p><p>Outra oportunidade &#233; aplicar a cultura do compartilhamento do conhecimento e de organiza&#231;&#227;o &#8220;org&#226;nica&#8221; para dentro da empresa. Convide outros colaboradores que n&#227;o fazem parte do projeto para participarem. Aproveite uma reuni&#227;o geral ou encontro que a empresa realiza e convide quem participou para compartilhar sua experi&#234;ncia. Incentive para que isto aconte&#231;a com maior frequ&#234;ncia, independente de ser um evento patrocinado pela empresa.</p><h3>Valide seu produto/servi&#231;o e crie oportunidades de&nbsp;neg&#243;cios</h3><p>Ao patrocinar grandes eventos ou espa&#231;os f&#237;sicos, a empresa poder&#225; promover desafios que poder&#227;o ser apenas para receber ideias/sugest&#245;es ou at&#233; mesmo criar solu&#231;&#245;es em cima de um produto/servi&#231;o (ideal para hackathons). Esta &#233; uma excelente oportunidade para receber feedback r&#225;pido e sem filtro do produto/servi&#231;o em quest&#227;o.</p><p>Se o objetivo da empresa &#233; apenas fomentar o uso, recomendo adotar um regulamento claro onde a propriedade intelectual do que est&#225; sendo feito &#233; do autor.</p><p>Caso a empresa tenha interesse em utilizar o que est&#225; sendo criado, recomendo formatar um regulamento que tamb&#233;m mantenha a propriedade intelectual, por&#233;m que permita o uso do que foi feito pela empresa.</p><p>Desafios e hackathons que transferem ou cedem a propriedade intelectual normalmente s&#227;o criticados pelos grupos/comunidades quando a premia&#231;&#227;o n&#227;o &#233; proporcional com o valor que a solu&#231;&#227;o pode ter para a organiza&#231;&#227;o.</p><p>&#201; muito importante criar e validar o regulamento com empresas que possuem experi&#234;ncia na realiza&#231;&#227;o de desafios deste tipo. Convide um l&#237;der de comunidade para auxili&#225;-lo e at&#233; validar o regulamento, desta forma voc&#234; ter&#225; uma opini&#227;o sem correr o risco dela estar &#8220;contaminada&#8221;. Mas lembre-se: essa rela&#231;&#227;o ainda n&#227;o &#233; comercial, portanto, n&#227;o extrapole. Aproveite os primeiros contatos para sentir se existe &#8220;fit&#8221; com a cultura da empresa. Existindo sinergia, contrate-o para uma consultoria pontual.</p><p>Outro ponto importante &#233; deixar claro para os participantes qual &#233; a expectativa da empresa ao realizar o desafio, se existir&#225; uma continuidade de relacionamento ou n&#227;o. Muitos participantes ficam frustrados pois criam uma expectativa de neg&#243;cio ou de contrata&#231;&#227;o que n&#227;o acontecem.</p><p>Leve em considera&#231;&#227;o a opini&#227;o da comunidade/grupo na evolu&#231;&#227;o de seu produto/servi&#231;o. Incentive a co-cria&#231;&#227;o. Convide-os a participar de sess&#245;es de valida&#231;&#227;o/entrevistas (presenciais ou remotas) para auxiliar no desenvolvimento e prioriza&#231;&#227;o do seu backlog. Voc&#234; ser&#225; muito mais assertivo e de quebra poder&#225; mostrar o envolvimento da comunidade/grupo na sua prioriza&#231;&#227;o, mostrando que eles influenciam a tomada de decis&#227;o.</p><h3>Coloque as dicas em&nbsp;pr&#225;tica</h3><p>Estas foram algumas dicas que entendo que ser&#227;o importantes para que a sua empresa tenha &#234;xito no relacionamento com ecossistemas existentes, em especial com comunidades/grupos. Eu j&#225; tive a oportunidade de estar nos dois lados da mesa (como patrocinador e patrocinado). Caso voc&#234; tenha d&#250;vidas ou precise de alguma orienta&#231;&#227;o, <a href="mailto:wupsbr@gmail.com">entre em contato</a> comigo que eu terei o maior prazer em ajud&#225;-lo.</p><p><em>Texto criado por <a href="https://www.linkedin.com/in/wupsbr/">David Ruiz</a> e revisado por <a href="https://www.linkedin.com/in/eusouakell/">Kell Bonassoli</a></em></p><p><em><strong>Quer ficar por dentro de novos artigos produzidos por mim ou pela Prensa? <a href="https://apiconnect.us12.list-manage.com/subscribe?u=46027fc5534ad3bf21ac2937b&amp;id=d52a3c2f91">Cadastre-se aqui</a>.</strong></em></p>]]></content:encoded></item></channel></rss>