15 perguntas que você deve fazer sobre sua API antes de selecionar uma plataforma

Perguntas de seleção de API

Um bom amigo e mentor escreveu e fez uma pergunta para mim e eu gostaria de usar minhas respostas para esta postagem. Suas perguntas eram um pouco mais focadas em um setor (e-mail), então generalizei minhas respostas para todas as APIs. Ele perguntou quais perguntas uma empresa deveria fazer a um fornecedor sobre sua API antes de fazer uma seleção.

Por que você precisa de APIs?

An interface de programação de aplicativo (API) é a interface que um sistema de computador, biblioteca ou aplicativo fornece para permitir que solicitações de serviços sejam feitas por outros programas de computador e / ou para permitir a troca de dados entre eles.

Wikipedia

Assim como você digita um URL e obtém uma resposta em uma página da web, uma API é um método onde seus sistemas podem solicitar e obter uma resposta para sincronizar os dados entre eles. À medida que as empresas procuram se transformar digitalmente, automatizar tarefas por meio de APIs é uma ótima maneira de melhorar a eficiência dentro da organização e reduzir o erro humano.

APIs são centrais para automação, especialmente em aplicativos de marketing. Um dos desafios ao comprar um grande fornecedor com uma ampla API é que os recursos e despesas de desenvolvimento geralmente são pensados ​​posteriormente. A equipe de marketing ou CMO pode conduzir a compra de um aplicativo e às vezes a equipe de desenvolvimento não recebe muitas informações.

Pesquisar os recursos de integração de uma plataforma por meio de uma API requer mais do que uma simples pergunta, Existe uma API?

Se você entrar com um aplicativo com uma API com suporte ou documentação insuficiente, você deixará sua equipe de desenvolvimento maluca e provavelmente suas integrações serão insuficientes ou falharão completamente. Encontre o fornecedor certo e sua integração funcionará e seu pessoal de desenvolvimento ficará feliz em ajudar!

Perguntas de pesquisa sobre seus recursos de API:

  1. Lacuna de recursos - Identifique quais recursos de sua interface de usuário estão disponíveis por meio da interface de programação de aplicativo. Quais recursos a API possui que a IU não possui e vice-versa?
  2. Escala - Pergunte quantas chamadas são feitas para seus API diariamente. Eles têm um pool dedicado de servidores? A quantidade é extremamente importante, pois você deseja identificar se a API é uma reflexão tardia ou realmente parte da estratégia da empresa.
  3. Documentação - Peça a documentação da API. Deve ser robusto, explicando todos os recursos e variáveis ​​disponíveis na API.
  4. Comunidade - Pergunte se eles têm ou não uma comunidade de desenvolvedores online disponível para compartilhar códigos e ideias com outros desenvolvedores. Comunidades de desenvolvedores são essenciais para lançar seus esforços de desenvolvimento e integração de forma rápida e eficiente. Em vez de alavancar 'o cara da API' na empresa, você também está aproveitando todos os seus clientes que já passaram por tentativas e erros ao integrar sua solução.
  5. REST vs SOAP - Pergunte que tipo de API eles têm… Normalmente, existem APIs REST e APIs de serviço da Web (SOAP). Eles podem estar desenvolvendo ambos. A integração com qualquer um dos dois tem benefícios e desvantagens ... você deve estar familiarizado com as capacidades de seus recursos de integração (TI).
  6. Idiomas - Pergunte a quais plataformas e aplicativos eles se integraram com sucesso e solicite contatos para que você possa descobrir com esses clientes como foi difícil integrar e como a API funciona.
  7. Limitações - Pergunte quais são as limitações do fornecedor em número de chamadas por hora, por dia, por semana, etc. Se você não estiver com um fornecedor escalável, seu crescimento será limitado pelo cliente.
  8. amostras - Eles oferecem uma biblioteca de exemplos de código para começar facilmente? Muitas empresas publicam SDK (Software Development Kits) para diferentes linguagens e estruturas que irão acelerar seu cronograma de integração.
  9. Sandbox - Eles oferecem um endpoint de não produção ou ambiente de sandbox para você testar seu código?
  10. Recursos - Pergunte se eles têm recursos de integração dedicados em sua empresa. Eles têm um grupo de consultoria interna disponível para integração? Se sim, inclua algumas horas no contrato!
  11. Segurança - Como eles se autenticam usando a API? São credenciais de usuário, chaves ou outras metodologias? Eles podem restringir solicitações por endereço IP?
  12. Uptime - Pergunte o que é deles API tempo de atividade e taxa de erro são, e quando são as horas de manutenção. Da mesma forma, as estratégias para contorná-los são importantes. Eles têm processos internos que tentarão novamente API chamadas no caso de o registro estar indisponível devido a outro processo? Isso é algo que eles criaram em sua solução?
  13. SLA - Eles têm um Service Level Agreement onde o tempo de atividade deve ser superior a 99.9%?
  14. Roteiro - Quais recursos futuros eles estão incorporando em sua API e quais são os cronogramas de entrega esperados?
  15. Integrações - Quais integrações productized eles desenvolveram ou que terceiros desenvolveram? Às vezes, as empresas podem abrir mão do desenvolvimento interno de recursos quando outra integração de produto já existe e está sendo suportada.

A chave para essas questões é que a integração 'casa' você com a plataforma. Você não quer se casar com alguém sem saber o máximo que puder sobre essa pessoa, quer? Isso é exatamente o que acontece quando as pessoas compram uma plataforma sem conhecimento de seus recursos de integração.

Além de uma API, você também deve tentar descobrir quais outros recursos de integração eles podem ter: código de barras, mapeamento, serviços de limpeza de dados, RSS, formulários da web, widgets, integrações formais de parceiros, mecanismos de script, quedas SFTP, etc.

3 Comentários

  1. 1
  2. 3

O que você acha?

Este site usa o Akismet para reduzir o spam. Saiba como seus dados de comentário são processados.