Referência da API de parceria

Este documento explica detalhes técnicos sobre o uso da API Partnership. Para obter uma introdução e requisitos, leia primeiro Introdução à API de Parceria.

Requisitos

The Partnership API is not available to your organization unless you're specifically instructed by your New Relic representative that you should use it.

Para ver os requisitos, consulte Introdução à API de Parceria.

Encontre sua chave de API de parceria

A API de parceria exige que você se autentique com a chave de API REST específica da sua conta de proprietário da parceria (você não pode usar a outra chave de API REST).

Ao usar sua chave de API de parceria com chamadas para o endpoint API REST (v2) que exigem o uso de um Admin user's API key, consulte a chave de API e parcerias do usuário administrador.

Encontre seu ID de parceiro

A API de parceria também exige que você se autentique fornecendo um ID de parceiro específico para sua parceria. Isso é exclusivo do ID da conta do proprietário da parceria.

Para obter seu ID de parceiro, acesse o console de administração do parceiro e recupere o número de ID de parceiro listado em seu URL:

https://partner-admin-console.newrelic.com/accounts/​$ACCOUNT_ID/admin_console/partnerships/$PARTNER_ID

Você deve incluir o ID do parceiro como parte do URL base da API do parceiro.

https://rpm.newrelic.com/api/v2/partners/PARTNER_ID

/accounts
/accounts/ACCOUNT_ID
/accounts/ACCOUNT_ID/users
/accounts/ACCOUNT_ID/users/USER_ID
/accounts/ACCOUNT_ID/subscriptions
/accounts/ACCOUNT_ID/subscriptions/SUBSCRIPTION_ID

https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

Autenticar a chamada de API

Para autenticar-se na Partner API ao fazer uma chamada de API:

1. Adicione um cabeçalho de solicitação denominado

   x-api-key

   e defina seu valor como

   Partner API key

   .

2. Inclua seu

   Partner ID

   no ponto especificado no URI da solicitação.

Notas para parceiros que gerenciam contas New Relic

Para parceiros que gerenciam contas New Relic para seus clientes, a chamada inicial da API para todas as interações no nível da conta é “criar conta”. Esta chamada retorna um registro xml da conta recém-criada. Parte deste registro é o account_id. Todas as outras chamadas na API Partnership requerem account_id como parâmetro. O parceiro precisará fazer o provisionamento para analisar a extração xml retornada, armazenar o account_id e associá-lo ao registro da conta do parceiro do usuário.

Erros

A New Relic usa códigos de resposta HTTP convencionais para indicar sucesso ou falha de uma solicitação de API. Em geral, os códigos no intervalo 2xx indicam sucesso e os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro obrigatório estava faltando).