Você deseja ter uma API sua, expondo dados do seu negócio, gerando novos modelos de negócio e participando ativamente de uma nova economia, a Economia de APIs?

Ainda não entendeu o que é uma API ou como ela funciona? Então esses artigos aqui são para você. Leia tudo, eu espero!

Expor grandes dados trazem grandes responsabilidades

Já está pronto para fazer exposição de APIs? Já sabe se ela será pública, para parceiros, ou só para uso interno? Já definiu qual a sua proposta de valor? Já conhece os 5 passos essenciais para expor sua API?

Então vamos lá! Eis os 10 mandamentos para expor sua API:

1. Entregue valor

Sua API deve gerar valor. Por que alguém iria ler a documentação, baixar bibliotecas e começar a programar em algo que não tenha uma proposta de valor única, com diferenciais em relação à concorrência?

Nesse sentido, sua API deve ser tratada por você como um produto. Lembre-se que não basta querer ter um filho, é preciso cuidar dele quando nascer. E se não houver uma boa razão para que ele exista, repense sua motivação.

2. Defina um modelo de negócios claro

Se você está lendo isso e não leu a introdução deste artigo, shame on you.

Sua API é um produto, e como tal, deve ser idealizada, planejada, criada e gerenciada. Não negligencie as primeiras etapas, ou a API pode custar caro para você.

Sua API é/será interna? Mesmo assim, você precisa saber quanto gasta com ela e quanto ela está economizando em horas de trabalho ou outro indicador de sucesso. Se a sua API estiver dando mais trabalho do que resolvendo problemas, o modelo de negócios da API deve ser repensado.

3. Conte histórias

Está sofrendo a síndrome de Field of Dreams (“Construa e eles virão”)? Nada na vida cai do céu – só chuva e meteoros. Quer pessoas interessadas e motivadas a usar sua API? Então você precisa dar razões para que se sintam motivadas. Conte histórias apaixonantes sobre o valor que sua API entrega, esforce-se em gerar cases de sucesso para seus devs e clientes.

Tenha alguém do Marketing trabalhando na sua API. Pela terceira vez: ela é um produto, então, só desenvolvedores cuidando dela não darão conta.

Senão, ninguém saberá ou ligará para a existência da sua API.

4. Disponibilize documentação de qualidade

Documentação simples, direto ao ponto, atualizada e acessível aos usuários.

Nada de PDF de 100 páginas anexado em email. Sua documentação deve ser facilmente atualizável e, ainda mais, interativa! Leia mais sobre isso aqui.

5. Disponibilize bibliotecas de código de qualidade

Você, com certeza, quer mais gente usando sua API e divulgando-a para amigos. Então, invista em diferentes linguagens de programação. Entregue códigos de exemplo, bibliotecas, SDKs e projetos iniciados em diferentes linguagens de programação.

Sem isso, sua API é só uma ilha perdida no mar. Facilite o acesso à comunidade de devs.

6. Defina termos de serviço

A partir de agora, o assunto é confiança. Há histórias demais de APIs sendo fechadas, restritas, sumindo ou reduzindo a liberdade de seus devs.

É claro que, se não fizer sentido para seu modelo de negócios, você não deve deixar a API lá só para satisfazer a comunidade.

Mas enquanto você prometer algo, seja fiel e justo.

Estabeleça termos que protejam os interesses da sua empresa, mas que ao mesmo tempo possibilitem os consumidores da API prosperar e crescer.

 7. Minimize quebras e bugs

Ainda no assunto confiança, como você espera que alguém goste de usar sua API ou pretenda criar aplicações úteis para seus próprios usuários, se não passa uma semana sem algum bug ou falha crítica?

Você nunca estabelecerá confiança com os consumidores da API se ela parar de funcionar o tempo todo.

Isso é básico e não deve ser subestimado. O primeiro e talvez até o segundo bug serão perdoados. Depois disso, a paciência acaba.

8. Segurança

Esse é um dos tópicos mais falados quando o assunto é API. Também há muitas histórias de APIs vazando dados restritos por aí. Você não quer ser a próxima manchete.

Práticas sólidas de segurança são essenciais para manter não só os seus recursos seguros, como também proteger todos os usuários envolvidos.

Nós temos um webinar completo para que você possa conhecer mais sobre segurança de APIs.

9. Privacidade

Qual o teor dos dados que você está lidando? Algo que seja minimamente íntimo e particular? Até mesmo o e-mail de seus usuários não deve ser usado de maneira inconveniente.

Seja sensato, e mais ainda, seja transparente. Tenha suas diretrizes de privacidade bem definidas. Se não souber o que está fazendo, consulte advogados e especialistas.

Proteja fortemente a privacidade tanto dos consumidores das APIs, quanto do usuário-final.

10. Ofereça suporte

Acha que sua missão está cumprida se os 9 mandamentos acima estiverem ok?

Não se engane. Mesmo que você tenha feito o máximo para deixar tudo cristalino e sem nenhum erro, ainda assim surgirão dúvidas e problemas. Sua API não será perfeita.

É claro que você sempre deve priorizar o suporte “self-service”, em que sua Documentação e Dev Portal estão ricos o suficiente para que alguém com dúvida consiga resolver sua vida sem acionar o suporte. Ter um fórum também ajuda nesses casos.

Além disso, é sua obrigação oferecer um sistema eficiente de suporte. Isso significa um canal de comunicação eficiente e útil, em que as reclamações são realmente resolvidas.

Se quiser trazer uma experiência mais completa de suporte, crie uma conta Premium e cobre pelo suporte. Isso pode ser o diferencial para certos parceiros que desejam monetizar aplicações que usem sua API.

Se você tiver essa lista na hora de expor sua API, garanto que terá um caminho sem pedras a sua frente.

Apesar desses mandamentos não garantirem o sucesso mercadológico da sua API, eles trazem no mínimo um grande aprendizado e crescimento da sua iniciativa em APIs.

É claro que esse assunto ainda pode ser aprofundado de muitas maneiras. Por isso, criamos o e-book de Blocos de Construção para Exposição de APIs. É gratuito, e complementa as ideias desse artigo. Clique na imagem abaixo para baixá-lo gratuitamente.