Referencia de API de asociación

Este documento explica detalles técnicos sobre el uso de la API de asociación. Para obtener una introducción y los requisitos, lea primero Introducción a la API de asociación.

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 conocer los requisitos, consulte Introducción a la API de asociación.

Encuentre su clave de API de asociación

La API de asociación requiere que se autentique con la clave de API REST que es específica de su cuenta de propietario de asociación (no puede usar la otra clave de API REST).

Cuando utilice su clave de API de asociación con llamadas a REST API (v2) extremo que requieren el uso de un Admin user's API key, consulte la clave de API y asociaciones del usuario administrador.

Encuentre su ID de socio

La API de asociación también requiere que usted se autentique proporcionando una ID de socio específica de su asociación. Esto es exclusivo del ID de cuenta de su cuenta de propietario de asociación.

Para obtener su ID de socio, vaya a la consola de administración de su socio y recupere el número de ID de socio que aparece en su URL:

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

Debe incluir el ID del socio como parte de la URL base de la API del socio.

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 la llamada API

Para autenticarse en la API de socio al realizar una llamada API:

1. Agregue un encabezado de solicitud con la etiqueta

   x-api-key

   y establezca su valor en su

   Partner API key

   .

2. Incluya su

   Partner ID

   en el punto especificado en el URI de solicitud.

Notas para socios que administran cuentas de New Relic

Para los socios que administran cuentas New Relic para sus clientes, la llamada API inicial para todas las interacciones a nivel de cuenta es "crear cuenta". Esta llamada devuelve un registro xml de la cuenta recién creada. Parte de este registro es el account_id. Todas las demás llamadas en la API de asociación requieren account_id como parámetro. El socio deberá tomar medidas para analizar el extracto xml devuelto, almacenar el account_id y asociarlo con el registro de cuenta del socio del usuario.

Errores

New Relic utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. En general, los códigos en el rango 2xx indican éxito y los códigos en el rango 4xx indican un error que resultó de la información proporcionada (por ejemplo, faltaba un parámetro requerido).