10
Leitura
10 de junho de 2020

Por que ter um Portal do Desenvolvedor é importante para os negócios?

Luciana Bandeira
Developer Experience

Você está ciente da importância de ter um Portal do Desenvolvedor disponível para os seus dispositivos que consomem as APIs? Neste post, mostraremos os benefícios deste Portal e como ele pode ajudar sua empresa a disseminar, disponibilizar e centralizar informações em um único canal.

O que é um Portal do Desenvolvedor?

É um portal focado nos desenvolvedores do cliente, contendo arquivos, documentos e especificações para uso das APIs, juntamente com possíveis regras, SDKs e outras informações necessárias para o desenvolvimento.

Por que ter um Portal do Desenvolvedor?

Uma ferramenta exclusiva com o objetivo de compartilhar e disseminar a documentação necessária para o uso de APIs, com um canal exclusivo e qualificado para a criação e gerenciamento de APIs. Na Sensedia, projetamos portais surpreendentes, sempre personalizados e capazes de atender às suas expectativas! Internamente, separamos as informações e a formatação em duas partes:

  • Documentação funcional

Fluxos básicos, API Guide, e Status Code. É desenvolvido por consultores que estão trabalhando no cliente ou quem quer que tenha desenvolvido o API.

  • Documentação técnica

Ao carregar a API, o módulo lê automaticamente o arquivo JSON e monta dinamicamente recursos, chamadas de amostra, etc. (dados que aparecem na API Browser).

O que você pode ter no Portal do Desenvolvedor?

Através do Portal, é possível fornecer informações, com padrões do Portal personalizados pela Sensedia, bem como a criação de mais páginas que agregam valor às APIs e garantem uma melhor assistência aos desenvolvedores.

API Browser

Página de disponibilização do swagger das APIs.

Criação de APPs

Integração direta com a Plataforma Sensedia, na qual é possível, através do Portal do Desenvolvedor, criar as chaves de acesso para utilizar as APIs, de acordo com as próprias regras do cliente, determinando quais ambientes poderão acessar.

Sistema de criação de conta

Ao se registrar no Portal, o desenvolvedor será automaticamente registrado no banco de dados com a Plataforma Sensedia. Ou seja, em um único banco de dados, é possível identificar os registros e realizar as integrações de comunicação.

Dashboard

Visualização das chamadas feitas pela APP criada na conta que está logada no Portal, sendo exibida para ambos os ambientes.

Concessão e restrição de acesso

Os diferentes tipos de conteúdo podem ser disponibilizados apenas para determinadas funções do usuário, determinando quais pessoas podem acessar determinadas páginas/documentação.

Blog e Fórum

Páginas para divulgação de informações e fóruns para discussões de desenvolvimento.

Navegador de arquivos

Aqui, os clientes podem fornecer aos usuários diferentes tipos de arquivos, tais como imagens, sem a necessidade de ter um sistema externo para armazenar essas imagens e arquivos. Ou seja, eles são capazes de armazenar uma imagem diretamente através do Portal, gerar um link para esta imagem e torná-la disponível em um texto na informação.

Ferramenta de tickets

Os usuários podem abrir bilhetes através do site Dev Portal para perguntas e dúvidas. Também é possível desativá-lo e, a critério do cliente, utilizar uma ferramenta externa (como a Zendesk).

Drupal CMS

Um sistema usado para fornecer conteúdo como páginas básicas e blocos de conteúdo, exemplos de páginas que podem ser criadas:

  • SDKs disponíveis para download;
  • Página com os primeiros passos sobre como realizar a integração;
  • Página contendo os termos de uso;
  • Páginas contendo fluxogramas das APIs;
  • FAQ para perguntas e respostas freqüentes que são fáceis de entender.

Sistema Multilíngüe

Com a expansão da Sensedia, tornou-se necessário criar e disponibilizar conteúdo em diferentes idiomas, com a possibilidade de segregar/visualizar este conteúdo em um menu lateral no Portal para facilitar a edição, o que é importante em casos de clientes internacionais.

Concluindo

Com todas estas informações e as informações demonstradas acima, sua empresa tem esta visão de benefícios do Portal do Desenvolvedor e está preparada para disponibilizar as informações para os desenvolvedores? Você gostaria de saber mais sobre como a Sensedia ajuda a melhorar Developer Experience para facilitar o consumo de APIs? Entre em contato conosco.

Obrigado pela leitura!