API de projeto opcional
Mostre as operações da aplicação conforme o combinado quando precisar.
Revise o escopo de uma API para um projeto elegível e diferencie as rotas planejadas dos endpoints já construídos.
Trate a API como uma opção definida do projeto
- Revise a opção
Verifique a disponibilidade da API e a oferta de projeto correspondente.
- Defina o escopo das rotas
Esclareça as operações de negócio que a API deve expor.
- Examine o catálogo de rotas
Consulte o método, o caminho e o status planejado ou ativo de cada rota.
Adicione uma API quando o seu projeto precisar
A API do projeto é uma parte opcional da oferta. Revise seu escopo e suas condições antes da ativação, em vez de supor que todo aplicativo a inclui.
As ferramentas de API organizam as rotas propostas por área de negócio. Os esclarecimentos ajudam a definir o que cada operação deve fazer antes de sua implementação.
Diferencie rotas planejadas de endpoints em funcionamento
Prepare o acesso para outro sistema. Um projeto pode precisar que outro aplicativo use suas operações de negócio. Revise o escopo e a oferta da API opcional em vez de supor que toda função é exposta automaticamente. As operações acordadas definem o que a integração deve acessar.
Examine o catálogo de rotas. O catálogo mostra o método, o caminho, a descrição e o status de cada rota. Ele ajuda a diferenciar o escopo proposto dos endpoints registrados como ativos. É uma referência prática para acompanhar a preparação da API.
Escolha a direção de integração correta. Usar a API de outro fornecedor e expor o seu próprio aplicativo são necessidades diferentes. As conexões externas cobrem o primeiro caso; a API do projeto cobre a exposição acordada. Escolha o caminho que corresponde à troca de negócio que você quer.
Diferencie uma API exposta de uma conexão externa
Uma API de projeto expõe as operações acordadas do seu aplicativo. Uma conexão externa descreve como seu aplicativo usa outro serviço; elas atendem a necessidades diferentes.
Use o catálogo de rotas para examinar o método, o caminho e se um endpoint está planejado ou ativo. Esta apresentação não ativa nenhuma API para o seu projeto.
Avalie a opção de API diante de uma necessidade concreta
Identifique quem vai consumir os dados do projeto e quais operações essa integração exige. Isso ajuda a diferenciar um escopo de API opcional de uma conexão com um serviço externo existente.
Em um projeto elegível, examine as rotas planejadas e seu estado de construção. Confirme o serviço e o ambiente correspondentes antes de considerar um endpoint disponível para uma integração.
De um escopo opcional a uma exposição verificada
Revise a disponibilidade e as condições. Verifique a opção de API na oferta real do projeto. Decida se o aplicativo precisa dessa exposição antes da ativação.
Esclareça as operações. Revise as operações de negócio propostas e responda às perguntas sobre o comportamento esperado. Acompanhe os estados de preparação e de construção.
Consulte o que está ativo. Examine o catálogo de rotas e a referência publicada de um projeto ativado. Uma rota planejada não é um endpoint em funcionamento.
Defina o escopo da integração antes de adicionar uma API
Explique as operações de que outro sistema precisa e revise as condições da opção. A API deve servir a uma troca de negócio acordada.
Perguntas sobre a API de projeto opcional
É uma opção cuja disponibilidade e preço aparecem na oferta real. Um aplicativo pode funcionar sem ativá-la. Esta apresentação não provisiona nem habilita nenhuma API para o seu projeto.
Ela descreve uma operação prevista que ainda não está registrada como endpoint ativo. Use o status do catálogo e a referência publicada real antes de iniciar uma integração.
As visualizações da API do projeto mostram as áreas a expor, as perguntas, a infraestrutura e os estados de construção. Resolva os pré-requisitos indicados e examine o catálogo de rotas resultante.
Use a referência de API do projeto ativado e do ambiente correspondente. Não deduza um endpoint nem um exemplo de autenticação apenas a partir de uma rota planejada.
Eles descrevem outro serviço que seu aplicativo usa. Essa direção de integração é diferente de expor as operações do seu próprio aplicativo pela API do projeto.