Usando nossas APIs

Eu só quero usar uma API? O que são planos?

Um plano é uma coleção de recursos da API ou de subconjuntos de recursos de uma ou mais APIs. Um plano pode conter uma mistura de tipos de operação de diferentes APIs. Um plano pode ter um limite de taxa comum para todos os recursos ou cada recurso pode ter um limite de taxa diferente. Os limites de taxa especificam quantas solicitações um aplicativo tem permissão para fazer durante um intervalo de tempo especificado.

Use este Portal do Desenvolvedor para procurar pelos diferentes planos disponíveis para você e selecione um plano que seja mais adequado aos seus requisitos. Alguns planos têm acesso restrito, para os quais é necessário solicitar acesso de uso. Quando sua solicitação for enviada, a organização será notificada, o administrador da API avaliará a solicitação e poderá entrar em contato para obter mais detalhes. Outros planos estão disponíveis para uso imediatamente.

Como eu vejo o meu uso da API?

Os números de solicitações, para diferentes APIs, feitas pelo aplicativo são mostrados na página do aplicativo.

Clique em 'Aplicativos' no menu principal e, em seguida, clique em seu aplicativo. Na tabela 'Assinaturas de produto' você verá todos os planos nos quais seu aplicativo está inscrito.

Para cada API contida nesse plano, é possível ver o uso em comparação ao limite de taxa do plano.

Como posso testar uma API?

É possível testar uma API a partir deste Portal do Desenvolvedor.

Ao examinar os detalhes de uma API, você verá uma lista das operações contidas na API. Isso mostrará o verbo e o caminho a serem usados para a operação.

Se você clicar na operação, verá mais informações sobre ela, quais parâmetros ela pode tomar, o que ela retorna, quais códigos de retorno possíveis ela pode usar e o que eles significam.

Há também um botão 'Tentar' nas APIs de REST, que permite que você experimente a operação diretamente do Portal do Desenvolvedor.

Se a API requer um ID de cliente ou um segredo do cliente para identificação, é possível especificá-los usando suas credenciais do aplicativo na parte superior da seção 'Tentar'.