Developer Experience
10
min de lectura
10 de junio de 2020

¿Por qué es importante para las empresas tener un portal para desarrolladores?

Luciana Bandeira
Developer Experience
Ayudo a los desarrolladores con onboarding y las mejores prácticas de la API para garantizar la mejor Developer Experience . En mi tiempo libre me dedico a los libros, a investigar (y probar) postres y me apasiona viajar.
Más sobre el autor

¿Es usted consciente de la importancia de tener un Portal de Desarrolladores a disposición de los desarrolladores que consumen las API? En este post, le mostraremos los beneficios de este Portal y cómo puede ayudar a su empresa a difundir, poner a disposición y centralizar la información en un solo canal.

¿Qué es un Portal de Desarrolladores?

Es un portal enfocado a los desarrolladores del cliente, que contiene archivos, documentos y especificaciones para el uso de las API, junto con posibles reglas, SDK y otra información necesaria para el desarrollo.

¿Por qué tener un portal para desarrolladores?

En Sensedia diseñamos portales sorprendentes, siempre personalizados y capaces de satisfacer sus expectativas! Internamente, separamos la información y el formato en dos partes:

  • Documentación funcional

Flujos básicos, API Guide, y Status Code. Es desarrollado por consultores que trabajan en el cliente o quien haya desarrollado la API.

  • Documentación técnica

Al subir el API, el módulo lee automáticamente el archivo JSON y ensambla dinámicamente los recursos, las llamadas de muestra, etc. (datos que aparecen en la página API Browser ).

¿Qué puedes tener en el Portal del Desarrollador?

A través del Portal, es posible proporcionar información, con los valores predeterminados del Portal personalizados por Sensedia, así como la creación de más páginas que añaden valor a las API y aseguran una mejor asistencia a los desarrolladores.

API Browser

Página de lanzamiento del swagger la API.

Creación de APPs

Integración directa con la Plataforma Sensedia, en la que es posible, a través del Portal del Desarrollador, crear las claves de acceso para utilizar las API, según las propias reglas del cliente que determinan a qué entornos podrán acceder.

Sistema de creación de cuentas

Al registrarse en el Portal, el desarrollador se registrará automáticamente en la base de datos con la Plataforma Sensedia. Es decir, en una sola base de datos es posible identificar los registros y realizar las integraciones de comunicación.

Dashboard

Visualización de las llamadas realizadas por el APP creado en la cuenta que está registrada en el Portal, siendo mostradas para ambos ambientes.

Concesión y restricción de acceso

Los diferentes tipos de contenido pueden ponerse a disposición sólo para determinadas funciones de usuario, lo que determina qué personas pueden acceder a determinadas páginas/documentación.

Blog y Fórum

Páginas de difusión de información y foros de debate sobre el desarrollo.

Navegador de archivos

Aquí, los clientes pueden proporcionar a los usuarios diferentes tipos de archivos, como imágenes, sin necesidad de tener un sistema externo para almacenar estas imágenes y archivos. Es decir, son capaces de almacenar una imagen directamente a través del Portal, generar un enlace a esta imagen y hacerla disponible en un texto en la información.

Herramienta de tickets

Los usuarios pueden abrir entradas a través de Dev Portal para preguntas y dudas. También es posible desactivarlo y, a discreción del cliente, utilizar una herramienta externa (como el Zendesk).

Drupal CMS

Un sistema utilizado para proporcionar contenido, como páginas básicas y bloques de contenido. Ejemplos de páginas que pueden ser creadas:

  • SDKs disponibles para descargar;
  • Página con los primeros pasos para realizar la integración;
  • Página que contiene las condiciones de uso;
  • Páginas que contienen diagramas de flujo de la API;
  • Preguntas frecuentes y respuestas fáciles de entender.

Sistema multilingüe

Con la expansión de Sensedia, se ha hecho necesario crear y poner a disposición contenidos en diferentes idiomas, con la posibilidad de segregar/visualizar estos contenidos en un menú lateral del Portal para facilitar su edición, lo que es importante en los casos de clientes internacionales.

Conclusión

Con toda esta información y los aportes demostrados anteriormente, ¿tiene su empresa esta visión de los beneficios del Portal del Desarrollador y está preparada para poner la información a disposición de los desarrolladores? ¿Le gustaría saber más sobre cómo Sensedia ayuda a mejorar Developer Experience para facilitar el consumo de las API? Contáctenos.

¡Gracias por leer!