Um API, abreviação de interface de programação de aplicativos, é uma maneira acordada de o software se comunicar com outro sistema. Um site fornece botões e páginas às pessoas; Uma API fornece ao software uma maneira definida de solicitar informações e entender a resposta.
Uma API é como um assistente faz uma pergunta ao chá à loja e obtém uma resposta exata em vez de adivinhar em uma página.
Pense nisso como um contador de serviços com um formulário de pedido claro. O formulário diz o que pode ser solicitado e a resposta diz o que a loja encontrou.
Solicitações e respostas
Uma solicitação é a pergunta enviada ao serviço. Pode incluir um identificador de produto ou condições, como um tipo de chá e um limite de preço. O ponto de extremidade do serviço é o endereço para onde essa solicitação vai. A resposta, às vezes chamada de carga útil, é a informação enviada de volta.
Uma resposta pode conter o nome do produto, o tamanho do pacote, o preço atual, o status do estoque e um link para sua página. Ele não deve distinguir nenhum produto correspondente de um serviço indisponível ou um fato desconhecido.
Os dois exemplos públicos em teas.co.uk
O Guia Pública para Software da loja descreve uma API de perguntas e conselhos e uma API do Product Truth para procurar um item exato. Este último pode usar identificadores, como um número de código de barras ou o código do produto da loja.
Essas rotas têm empregos diferentes. Uma questão ampla precisa de interpretação; Uma pesquisa exata do produto precisa da identidade certa. O Guia de Filtros e Restrições explica como uma solicitação detalhada pode ser verificada em relação aos atributos do produto.
JSON e Markdown
O software geralmente recebe JSON, um formato para valores e listas nomeados. Um artigo mais longo também pode estar disponível como marcação, texto simples com marcas simples para títulos e links. Ambos podem tornar as informações mais fáceis de reutilizar. Nenhum deles é uma fonte separada de verdade se for gerada a partir do mesmo registro mantido.
Ler é diferente de mudar algo
Procurar um produto lê informações. Adicionar um produto a uma cesta muda algo. Pagar é outra ação. A existência de uma API não diz nada por si só sobre qual dessas ações é permitida.
O cliente continua responsável por verificar a cesta e pagar no local da loja.
formatos citáveis
Para jornalistas, pesquisadores, assistentes de IA e criadores de conteúdo. Escolha o formato que você precisa:
- Baixe o arquivo .md Limpar exportação de remarcação
- Baixe o arquivo .json Exportação de dados estruturados
Livre para citar, citar e reutilizar com atribuição a Teas.co.uk.
Tem algo a acrescentar? Os clientes conectados podem enviar adições ao Tea Wiki, aprovado pelo administrador, seu nome na assinatura, além de pontos de recompensa.
Faça login para contribuir