[Shenzhen] Yuanchuanghui: 17.26, el salón de fiestas te está esperando”.

Muchos amigos ya eran muy competentes en el negocio que estaban haciendo cuando se convirtieron en gerentes de producto por primera vez, pero inevitablemente escucharon quejas de los desarrolladores: "¿Por qué hay tantas demandas alineadas y tantas interfaces que no se pueden completar?" El gerente solo dijo. ¿Puedes expresar con una mirada confusa: Interfaz? ¿Lo que es? ¿No he escrito ya en detalle las funciones de mi página en el documento?

De hecho, a nivel del sistema, además del contenido visible como redacción publicitaria y botones, también hay muchas cadenas lógicas ocultas debajo del contenido: interfaces, que a menudo llamamos API . Este artículo lo ayudará a comprender y utilizar mejor las API basándose en el conocimiento básico de las API y los escenarios comerciales específicos de los gerentes de productos, para que pueda cooperar de manera más eficiente con los desarrolladores.

¿Qué es API?

API, o interfaz de programa de aplicación, es un conjunto de reglas definidas que permiten que diferentes aplicaciones se comuniquen entre sí. Actúa como una capa intermedia que maneja la transferencia de datos entre sistemas, lo que permite a las empresas abrir los datos y la funcionalidad de sus aplicaciones a desarrolladores externos, socios comerciales y departamentos internos de la empresa.

Fuente de la imagen: CSDN@tbprice

El funcionamiento de la API es realmente fácil de entender. Podemos comprender fácilmente cómo funciona la API explicándola mediante el pago de WeChat. Cuando ordenamos comida para llevar, el sistema nos pedirá que "utilicemos el pago WeChat" u otros tipos de métodos de pago de terceros. Esta función de pago depende de la API para completarse. Cuando hacemos clic en el botón de pago, se realiza una llamada API para recuperar la información (también llamada solicitud). La solicitud se maneja desde la aplicación al servidor web a través del Identificador uniforme de recursos (URI) de la API, que incluye el verbo de solicitud, los encabezados y, a veces, el cuerpo de la solicitud.

Después de recibir una solicitud válida de la página web del producto, la API llama a un programa externo o servidor web, es decir, un sistema de pago de terceros. El servidor envía una respuesta a la API que contiene la información solicitada. La API transfiere datos a la aplicación solicitante inicial, en este caso el sitio web del producto. Aunque la transferencia de datos varía según el servicio web utilizado, todas las solicitudes y respuestas se producen a través de la API. Estas transferencias no son visibles para la interfaz de usuario, lo que significa que la API intercambia datos dentro de la computadora o aplicación y al usuario le parece una conexión fluida y fluida.

¿Cómo se clasifican las API?

A medida que cambien los escenarios de comunicación, las dimensiones de clasificación de las API también serán diferentes:

Dividido según el proveedor de API: API propia, API de terceros (por ejemplo: autenticación de identidad , servicio de SMS , servicio de pago , modelo grande de IA , etc.).
Dividido según los atributos técnicos de la API: API del sistema (por ejemplo: almacenamiento en caché, sincronización, notificación, monitoreo, etc.), API comercial (API de membresía, API de producto, API de contenido, API de transacciones, etc.), API de plataforma (API de inicio de sesión individual). , API de búsqueda, servicio al cliente de IA) API, etc.).
Dividido según los métodos de llamada API: API síncrona, API asíncrona.
Dividido según la granularidad de la API: API de servicio (por ejemplo: API de Meituan Takeaway , API de Taobao Mall, API de JD Express, etc.), API funcionales (por ejemplo: API de cadena corta , API de ubicación , API de autenticación empresarial , etc.).
Dividido según si la API está abierta al mundo exterior: API interna, API abierta.

¿En qué escenarios los gerentes de producto necesitan diseñar API?

Al desarrollar aplicaciones basadas en Internet (aplicaciones SPA, aplicaciones APP, programas pequeños, aplicaciones para dispositivos inteligentes, etc.), la arquitectura técnica es básicamente un modelo cliente-servidor. En este momento, el servidor es básicamente una API y el administrador del producto. sólo necesita describir el negocio.
Al proporcionar interfaces técnicas a usuarios ascendentes y descendentes, básicamente se proporcionan en forma de API. En este momento, los gerentes de producto deben diseñar y definir API.
Cuando los servicios empresariales se monetizan y se proporcionan como API, los gerentes de producto deben diseñar API, definir API, fijar precios de API, etc.

¿En qué escenarios los gerentes de producto utilizarán API de terceros?

Debido a factores de costo, factores de retención de datos o recursos, factores de capacidad técnica, etc., cuando las empresas desarrollan sistemas digitales, es imposible que todos los servicios los desarrollen ellas mismas, ni se construirán utilizando código fuente abierto de terceros. Las API de terceros se han convertido en una elección inevitable.

Escenarios básicos comunes, como el inicio de sesión: al diseñar una aplicación, la función más básica es la función de inicio de sesión del usuario. Los usuarios no necesitan registrar cuentas separadas en cada software, pero pueden usar WeChat, QQ, Alipay y otras cuentas para iniciar sesión. el programa. Escenarios similares incluyen autenticación KYC , inicio de sesión único, gestión de seguridad, recaudación y pago de fondos, intercambio social, comunicación con el usuario, etc.

Escenarios que utilizan recursos de la plataforma, como reservas de viajes : la función básica del software de las principales plataformas de viajes es agregar información de vuelos y hoteles y mostrar diferentes precios en diferentes fechas. Por lo general, estos datos provienen de miles de sitios web y páginas de inicio, y este servicio también se completa a través de API. Escenarios similares incluyen entrega urgente y logística , plataformas de comida para llevar, varias plataformas importantes de comercio electrónico, etc. Las empresas deben utilizar API de terceros.

Escenarios que utilizan capacidades técnicas de terceros, como modelos grandes de IA : los modelos grandes de IA son los nuevos favoritos en 24 años. La mayoría de las empresas no pueden desarrollarlos por sí mismas y los utilizarán principalmente. Escenarios similares también incluyen tecnología de computación en la nube, tecnología blockchain , tecnología de big data, tecnología de almacenamiento, etc.

Utilice aplicaciones SaaS empresariales como CRM : las plataformas como CRM (herramientas de gestión de relaciones con el cliente) a menudo incluyen muchas API integradas que permiten a las empresas integrarse con las aplicaciones que ya utilizan, como mensajería, redes sociales y aplicaciones de correo electrónico. Esto reduce significativamente el tiempo dedicado a cambiar entre diferentes aplicaciones para realizar tareas de ventas y marketing. Escenarios similares incluyen SaaS financiero, SaaS humano, SaaS de oficina, SaaS de marketing, etc.

¿Cómo escribe un gerente de producto una buena documentación de producto API?

Los principales lectores del PRD de productos son el desarrollo back-end (RD), el desarrollo front-end (FE), los diseñadores de interacción (UI, UE) y las pruebas (QA). Obtendrán los objetivos de trabajo que necesitan completar en el PRD. y utilícelos para diseñar el plan básico.

En el artículo anterior, aprendimos conocimientos de API y teníamos un lenguaje para comunicarnos con los desarrolladores. Ahora necesitamos transformar este conocimiento en una descripción de nuestras necesidades para que los desarrolladores puedan comprender nuestras necesidades.

El siguiente es un caso específico: supongamos que somos el administrador de productos de una plataforma de comercio electrónico y ahora necesitamos diseñar una nueva API para implementar la función de crear pedidos de usuarios. Al redactar la documentación del producto API, debemos considerar los siguientes aspectos.

Descripción de la función de la interfaz : Primero, debemos aclarar cuál es la función de esta API, es decir, la creación de pedidos de usuarios. Describa la función en detalle en el documento, incluidos los parámetros de entrada, los resultados de salida, etc.
Descripción del parámetro : Para la función de creación de pedidos, pueden estar involucrados parámetros como información del usuario, información del producto, información de pago, etc. Enumere todos los parámetros posibles en el documento y explique el significado, el tipo y si cada parámetro es necesario.
Ejemplos de solicitud : proporcione varios ejemplos de solicitudes específicas para mostrar cómo los desarrolladores llaman a la API para implementar la función de creación de pedidos. Los ejemplos deben cubrir combinaciones de parámetros en diferentes situaciones para garantizar una comprensión clara por parte de los desarrolladores.
Resultado devuelto : describe qué tipo de resultado devuelto se obtendrá después de llamar a la API, incluido el éxito y el fracaso. En caso de éxito, se debe describir detalladamente la información del pedido devuelto; en caso de fracaso, se debe explicar el motivo del fracaso.
Definición de código de error : defina posibles códigos de error y sus significados para que los desarrolladores puedan localizar rápidamente problemas en función de los códigos de error al llamar a las API.
Consideraciones de seguridad : para las API que involucran información confidencial, como la privacidad del usuario o el pago, se debe considerar la seguridad. Explique en el documento cómo garantizar la seguridad de la información del usuario, como el uso del protocolo HTTPS, el cifrado de parámetros, etc.

A través de la descripción detallada anterior, los gerentes de producto pueden escribir documentación de producto API clara y completa, comunicar de manera efectiva los requisitos a los desarrolladores y garantizar que puedan implementar correctamente las funciones requeridas.

¿Cómo comunicarse con el equipo de desarrollo sobre API?

Estándares uniformes

La comunicación es imprescindible para el proyecto. Antes de conectarse con socios de desarrollo, los gerentes de producto deben prestar atención a unificar estándares y métodos para una mejor modificación y seguimiento.

plataforma unificada

Con la ayuda de plataformas modernas, como la plataforma iPaaS y la puerta de enlace API, las empresas primero establecen coherencia en la implementación en el nivel técnico subyacente, aprovechan las capacidades de la plataforma, ignoran la complejidad técnica y se centran en el negocio mismo.

herramienta unificada

Cuando el personal técnico lleva a cabo el diseño de API, puede utilizar herramientas de diseño de API para permitir que los gerentes de productos, desarrolladores y evaluadores se comuniquen, programen, actualicen y mantengan en una vista común.

Conocimiento técnico de API esencial para gerentes de producto