7 erros mais comuns na hora de criar uma API

Qua, Set 22, 2010

Cloud Computing

Uma estratégia que já se consolidou no mundo da internet são o uso de APIs para expandir as capacidades de um produto. Inclusive aqui no Brasil já temos iniciativas neste sentido. Exemplos como o Twitter, Facebook, Google Maps e Youtube, que tem comunidades desenvolvedores bem ativos, inspiram muitas startups a criar seus próprios ecossistemas. Mas para cada um destes exemplos existem milhares de startups que falharam miseravelmente ao criar suas APIs e plataformas. Primeiro vamos aos erros mais comuns na hora de criar uma API :

Não tratar sua API como um produto

Muitas empresas criam uma API como subproduto e a deixam a deriva, esperando que milagrosamente uma multidão de desenvolvedores vai bater na porta. Mesmo que sua API seja um subproduto de outro projeto trate-a como se fosse um produto independente.

Documentação ruim

Desenvolvedores são seres super ocupados e na maior parte dos casos loucos por eficiência. Se eles forem demorar horas para achar o que querem na sua documentação eles vão procurar uma alternativa, muitas vezes dos seus concorrentes. A vida de desenvolvedor já é difícil sem sua documentação confusa para atrapalhar.

Não criar uma sandbox

APIs muitas vezes exigem que os desenvolvedores se registrem para receber algum token de autenticação ou para colocar formas de pagamento. Se sua API exige esforço do desenvolvedor antes que ele tenha oportunidade experimentar cria uma sandbox. Uma sandbox é um local onde os usuários da sua API podem fazer testes com parâmetros e respostas sem ter que se preocupar com demais burocracias. Vai ser neste lugar que os seus desenvolvedores vão aprender sua API sem se preocupar em ter que pagar uma conta milionário no final do mês.

Não colocar a API em domínio separado da aplicação

No inicio pode ser que sua API esteja até na mesma máquina que sua aplicação. Isto não é o mais recomendado mas muitas startups fazem assim. Se você vai mesmo colocar tudo junto pelo menos coloque em domínios separados. Isto vai te dar maior tranquilidade na hora de escalar independentemente sua api. É melhor ter um api.myservice.com do que um myservice.com/api

Não ter um gerenciamento de comunidade

Sem uma comunidade de desenvolvedores dispostos a ajudar ums aos outros sua api está fadada ao fracasso. Criar uma comunidade exige tem e atenção. Um grupo de desenvolvedores dificilmente vai se juntar em torno de sua API sem um esforço muito grande da sua parte primeiro. Crie foruns, blogs, comente, responda, interaja enfim seja humano.

Não esperar mal comportamento

Alguém vai tentar quebrar sua API. Seja por curiosidade, seja com intenções criminosas esteja preparado para mal uso da sua API . Mantenha um sistema de monitorando constante para evitar surpresas desagradáveis.

Não tratar sua API como uma oportunidade de negócios

Sua API pode se tornar o principal produto da sua empresa. Permitir que outros criem algo a partir da tecnologia e produtos da sua empresa pode gerar um efeito em cascata maior do que o efeito original de seus produtos e serviços. Não descarte a possibilidade de sua API no futuro ser o maior driver de uso da sua plataforma.

,

Por:

Que escreveu 38 posts em Escalabilidade.


Fale com o autor