[Shenzhen] Yuanchuanghui: 17h26, o salão de festas está esperando por você.”

Muitos amigos já eram muito proficientes no negócio que faziam quando se tornaram gerentes de produto, mas inevitavelmente ouviam reclamações de desenvolvedores: “Por que há tantas demandas alinhadas e tantas interfaces não podem ser concluídas?” o gerente apenas disse Você consegue expressar com um olhar confuso: Interface? O que é isso? Ainda não escrevi detalhadamente as funções da minha página no documento?

Na verdade, no nível do sistema, além do conteúdo visível, como direitos autorais e botões, também existem muitas cadeias lógicas ocultas sob as interfaces de conteúdo, que muitas vezes chamamos de APIs . Este artigo ajudará você a entender e usar melhor APIs com base no conhecimento básico de APIs e nos cenários de negócios específicos dos gerentes de produto, para que você possa cooperar de forma mais eficiente com os desenvolvedores.

O que é API?

API, ou Application Program Interface, é um conjunto de regras definidas que permitem que diferentes aplicativos se comuniquem entre si. Ele atua como uma camada intermediária que lida com a transferência de dados entre sistemas, permitindo que as empresas abram os dados e funcionalidades de seus aplicativos para desenvolvedores terceirizados externos, parceiros de negócios e departamentos internos da empresa.

Fonte da imagem: CSDN@tbprice

Como a API funciona é realmente fácil de entender. Podemos entender facilmente como a API funciona explicando-a por meio do pagamento WeChat. Quando pedimos comida para viagem, o sistema nos solicitará "usar o pagamento WeChat" ou outros tipos de métodos de pagamento de terceiros. Esta função de pagamento depende da API para ser concluída. Ao clicar no botão de pagamento, é feita uma chamada de API para recuperar as informações (também chamada de solicitação). A solicitação é tratada do aplicativo para o servidor Web por meio do URI (Uniform Resource Identifier) da API, que inclui o verbo da solicitação, os cabeçalhos e, às vezes, o corpo da solicitação.

Após receber uma solicitação válida da página web do produto, a API chama um programa externo ou servidor web, ou seja, um sistema de pagamento de terceiros. O servidor envia uma resposta à API contendo as informações solicitadas. A API transfere dados para o aplicativo solicitante inicial, neste caso o site do produto. Embora a transferência de dados varie dependendo do serviço web utilizado, todas as solicitações e respostas ocorrem por meio da API. Essas transferências não são visíveis para a interface do usuário, o que significa que a API troca dados dentro do computador ou aplicativo e parece ao usuário uma conexão suave e contínua.

Como as APIs são classificadas?

À medida que os cenários de comunicação mudam, as dimensões de classificação das APIs também serão diferentes:

Dividido de acordo com os provedores de API: API própria, API de terceiros (por exemplo: autenticação de identidade , serviço de SMS , serviço de pagamento , modelo grande de IA , etc.).
Dividido de acordo com os atributos técnicos da API: API do sistema (por exemplo: cache, tempo, notificação, monitoramento, etc.), API de negócios (API de associação, API de produto, API de conteúdo, API de transação, etc.), API de plataforma (API de login individual , API de pesquisa, API de atendimento ao cliente de IA, etc.).
Dividido de acordo com os métodos de chamada de API: API síncrona, API assíncrona.
Dividido de acordo com a granularidade da API: APIs de serviço (por exemplo: API Meituan Takeaway , API Taobao Mall, API JD Express, etc.), APIs funcionais (por exemplo: API de cadeia curta , API de localização , API de autenticação corporativa , etc.).
Dividido de acordo com a abertura da API ao mundo exterior: API interna, API aberta.

Em quais cenários os gerentes de produto precisam projetar APIs?

Ao desenvolver aplicativos baseados na Internet (aplicativos SPA, aplicativos APP, pequenos programas, aplicativos para dispositivos inteligentes, etc.), a arquitetura técnica é basicamente um modelo cliente-servidor. Neste momento, o servidor é basicamente uma API e o gerente de produto. só precisa descrever o negócio.
Ao fornecer interfaces técnicas para usuários upstream e downstream, elas são basicamente fornecidas na forma de APIs. Neste momento, os gerentes de produto precisam projetar e definir APIs.
Quando os serviços empresariais são monetizados e fornecidos como APIs, os gerentes de produto precisam projetar APIs, definir APIs, definir preços de APIs, etc.

Em quais cenários os gerentes de produto usarão APIs de terceiros?

Devido a fatores de custo, fatores de retenção de dados ou recursos, fatores de capacidade técnica, etc., quando as empresas desenvolvem sistemas digitais, é impossível que todos os serviços sejam desenvolvidos por si próprios, nem serão construídos usando código-fonte aberto. APIs de terceiros se tornaram uma escolha inevitável.

Cenários básicos comuns, como login: Ao projetar um aplicativo, a função mais básica é a função de login do usuário. Os usuários não precisam registrar contas separadas em cada software, mas podem usar WeChat, QQ, Alipay e outras contas para fazer login. o programa de aplicação. Cenários semelhantes incluem autenticação KYC , logon único, gerenciamento de segurança, coleta e pagamento de fundos, compartilhamento social, comunicação do usuário, etc.

Cenários que utilizam recursos da plataforma, como reservas de viagens : A função básica dos principais softwares de plataformas de viagens é agregar informações de voos e hotéis e exibir preços diferentes em datas diferentes. Normalmente esses dados vêm de milhares de sites e homepages, e esse serviço também é realizado por meio de API. Cenários semelhantes incluem entrega expressa e logística , plataformas de entrega, várias plataformas importantes de comércio eletrônico, etc. As empresas devem usar APIs de terceiros.

Cenários que usam recursos técnicos de terceiros, como grandes modelos de IA : Os grandes modelos de IA são os novos favoritos em 24 anos. A maioria das empresas não pode desenvolvê-los por conta própria e irá utilizá-los principalmente. Cenários semelhantes também incluem tecnologia de computação em nuvem, tecnologia blockchain , tecnologia de big data, tecnologia de armazenamento, etc.

Use aplicativos SaaS corporativos, como CRM : plataformas como CRM (ferramentas de gerenciamento de relacionamento com o cliente) geralmente incluem muitas APIs integradas que permitem que as empresas se integrem aos aplicativos que já usam, como mensagens, mídias sociais e aplicativos de e-mail. Isso reduz significativamente o tempo gasto alternando entre diferentes aplicativos para realizar tarefas de vendas e marketing. Cenários semelhantes incluem SaaS financeiro, SaaS humano, SaaS de escritório, SaaS de marketing, etc.

Como um gerente de produto escreve uma boa documentação de produto de API?

Os principais leitores do PRD de produto são desenvolvimento back-end (RD), desenvolvimento front-end (FE), designers de interação (UI, UE) e testes (QA). Eles obterão as metas de trabalho necessárias para concluir no PRD. e use-os para projetar o plano básico.

No artigo anterior, aprendemos conhecimentos de API e tínhamos uma linguagem para nos comunicarmos com os desenvolvedores. Agora precisamos transformar esse conhecimento em uma descrição de nossas necessidades para que os desenvolvedores possam entender nossas necessidades.

O seguinte é um caso específico: suponha que somos gerentes de produto de uma plataforma de e-commerce e agora precisamos projetar uma nova API para implementar a função de criação de pedidos de usuários. Ao escrever a documentação do produto API, precisamos considerar os seguintes aspectos.

Descrição da função da interface : Primeiramente precisamos esclarecer qual é a função desta API, ou seja, a criação de pedidos de usuários. Descreva a função detalhadamente no documento, incluindo parâmetros de entrada, resultados de saída, etc.
Descrição do parâmetro : Para a função de criação de pedido, parâmetros como informações do usuário, informações do produto, informações de pagamento, etc. Liste todos os parâmetros possíveis no documento e explique o significado, o tipo e se cada parâmetro é obrigatório.
Exemplos de solicitação : forneça vários exemplos de solicitação específicos para mostrar como os desenvolvedores chamam a API para implementar a função de criação de pedido. Os exemplos devem abranger combinações de parâmetros em diferentes situações para garantir uma compreensão clara pelos desenvolvedores.
Resultado de retorno : descreve que tipo de resultado de retorno será obtido após chamar a API, incluindo sucesso e falha. Em caso de sucesso, as informações do pedido devolvido deverão ser detalhadas; em caso de falha, o motivo da falha deverá ser explicado;
Definição de código de erro : defina possíveis códigos de erro e seus significados para que os desenvolvedores possam localizar rapidamente os problemas com base nos códigos de erro ao chamar APIs.
Considerações de segurança : Para APIs que envolvem informações confidenciais, como privacidade do usuário ou pagamento, a segurança precisa ser considerada. Explique no documento como garantir a segurança das informações do usuário, como uso do protocolo HTTPS, criptografia de parâmetros, etc.

Por meio da descrição detalhada acima, os gerentes de produto podem escrever uma documentação clara e completa do produto API, comunicar efetivamente os requisitos aos desenvolvedores e garantir que eles possam implementar corretamente as funções necessárias.

Como se comunicar com a equipe de desenvolvimento sobre API?

Padrões uniformes

A comunicação é uma obrigação para o projeto. Antes de se conectarem com parceiros de desenvolvimento, os gerentes de produto devem prestar atenção à unificação de padrões e métodos para melhor modificação e acompanhamento.

plataforma unificada

Com a ajuda de plataformas modernas, como a plataforma iPaaS e o gateway API, as empresas primeiro estabelecem consistência de implementação no nível técnico subjacente, aproveitam os recursos da plataforma, ignoram a complexidade técnica e concentram-se no próprio negócio.

ferramenta unificada

Quando o pessoal técnico realiza o design da API, ele pode usar ferramentas de design da API para permitir que gerentes de produto, desenvolvedores e testadores se comuniquem, programem, atualizem e mantenham uma visão comum.

Conhecimento técnico essencial de API para gerentes de produto