Objeto de cuenta API de asociación

Este documento explica cómo utilizar la API de asociación para administrar cuentas. Para cuentas infantiles, utilizarías el objeto de cuenta infantil .

Requisitos

Antes de utilizar esta API, tenga en cuenta:

Esta API no está disponible para usted a menos que un representante de New Relic le haya indicado a su organización que la use.
Es posible que no tenga acceso para utilizar este objeto específico. Antes de usar, primero lea los requisitos.

Atributo de objeto de cuenta

Aquí está el atributo del objeto de cuenta de Partnership API .

Tipo:	Cadena
Por defecto:	(ninguno)

El atributo del nombre de la cuenta es required para cuentas nuevas.

Este nombre debe ser único en la base de datos de New Relic. Si el nombre especificado no es único, se incrementará automáticamente con un sufijo numérico de la siguiente manera:

conflicting_name_1
conflicting_name_2
etc.

Tipo:	Booleano
Por defecto:	FALSO

Utilice esta bandera para indicar una cuenta de prueba. Se supone que las cuentas de prueba contienen datos basura y los sistemas internos las ignoran. Los datos que generan podrán ser eliminados en cualquier momento.

Tipo:	Matriz
Por defecto:	(ninguno)

Una matriz que define una lista de usuarios. Existen algunas restricciones dependiendo del estado de su cuenta:

Para asociaciones de clientes que han migrado su usuario a nuestro nuevo modelo de usuario más reciente: No defina usuario. Si agrega un usuario con este campo, será ignorado. En su lugar, para agregar un usuario, deberá utilizar estos procedimientos de administración de usuarios.
Para todas las demás cuentas, que tienen un usuario en nuestro modelo de usuario original: cuando crea una cuenta por primera vez, este campo es obligatorio y solo se puede definir un usuario: la cuenta Owner. Para agregar un usuario adicional, utilice el objeto de usuario API de asociación.
Para obtener más información sobre las restricciones, lea los Requisitos.

Tipo:	Matriz
Por defecto:	(ninguno)

Una matriz que define una lista de suscripción. Existen algunas restricciones dependiendo del estado de su cuenta:

Para asociaciones con clientes en nuestro modelo de precios basado en el uso: ignore este campo porque se aplica al modelo de precios original, no al suyo. Si usa esto, será ignorado.
Para todas las demás cuentas: estás en nuestro modelo de precios original basado en productos. El atributo subscriptions es required para cuentas nuevas. Si está vacío, se utilizará el nivel de producto predeterminado. Para actualizar la información de suscripción, utilice el objeto de suscripción de Partnership API.
Importante
Al crear una cuenta con este objeto, la configuración de la cuenta puede tardar algún tiempo en completarse. Esto significa que la respuesta devuelta puede mostrar inicialmente aspectos que no son ciertos (por ejemplo, puede devolver una respuesta que muestre la suscripción Lite predeterminada).
Para especificar una matriz JSON vacía, no utilice subscriptions: [ {} ]. En su lugar, utilice este formato:
```
subscriptions: [  ]
```

La API de la cuenta no incluye un atributo para crear una cuenta infantil. En su lugar, para crear cuentas infantiles, utilice la página de la Account settings cuenta principal en la New Relic UI.

API de llamada de cuenta

Estos son los patrones de URL para las funciones API de la cuenta. Si utiliza este patrón de URL, envíe un encabezado HTTP que contenga la clave de API del socio junto con el cuerpo de la solicitud JSON. Por ejemplo:

GET .../api/v2/partners/:PARTNER_ID/accounts/:ID
x-api-key: :PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

Llamar	Patrón de URL de recurso
Enumere (index) todas las cuentas de un socio.	`GET /api/v2/partners/PARTNER_ID/accounts`
Show el atributo de una cuenta.	`GET /api/v2/partners/PARTNER_ID/accounts/:ID`
Update el atributo de una cuenta.	`PUT /api/v2/partners/PARTNER_ID/accounts/:ID`
Create una cuenta con el parámetro dado.	`POST /api/v2/partners/PARTNER_ID/accounts`
Cancel una cuenta.	`DELETE /api/v2/partners/PARTNER_ID/accounts/:ID`

Definiciones de estado

Cuando se crea o enumera una cuenta con una llamada API, el estado de la cuenta se incluye automáticamente. Algunos de estos estados no se aplican a todos los modelos de precios.

Estado de la cuenta	Definición
`pending`	Se creó una cuenta gratuita, pero el administrador principal aún no está activado.
`paid_pending`	Cuenta creada con una suscripción paga, pero el administrador principal aún no está activado.
`new`	Cuenta gratuita, administrador principal activo, no se han recopilado datos de la aplicación.
`paid_new`	Suscripción paga, administrador principal activo, no se han recopilado datos de la aplicación.
`active`	Suscripción gratuita, recibiendo datos de la aplicación.
`paid_active`	Suscripción paga, recibiendo datos de la aplicación.
`upgraded`	Se actualizó la suscripción de la cuenta.
`downgraded`	La suscripción de la cuenta fue rebajada.
`cancelled`	La suscripción a la cuenta New Relic ha sido cancelada.
`suspended`	La cuenta de New Relic ha sido suspendida porque el administrador principal no ha validado su dirección de correo electrónico.

Ejemplo JSON

A continuación se muestra un ejemplo de una solicitud y respuesta JSON utilizando el objeto de cuenta de Partnership API.

Note that this is just an example, and that for some accounts, the users and subscriptions attributes are unnecessary and are ignored.

{
  "account": {
    "name": "Sample Account",
    "application_type": "ruby",
    "users": [
      {
        "email": "sample_user@sample.org",
        "password": "XXXXXXXX",
        "owner": true,
        "role": "admin",
        "first_name": "Sample",
        "last_name": "User"
      }
    ],
    "subscriptions": [
      {
        "product_id": 4,
        "quantity": 10
      },
        {
        "product_id": 10,
        "quantity": 0
      }
    ],
    "allow_api_access": true,
    "phone_number": "555-555-5555"
  }
}

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1990.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

Ejemplos de API de objetos de cuenta

Las asociaciones con más de 1000 cuentas devuelven una respuesta paginada. Para especificar una página, agregue el siguiente parámetro a la consulta:

?page=

A continuación se muestran ejemplos de llamadas que utilizan el objeto de cuenta de la API de asociación. Note that these are examples, and that for some accounts, the users and subscriptions attributes don't apply and will be ignored.

Solicitud de lista:

curl -X GET \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts

Respuesta (los saltos de línea son para facilitar la lectura):

{
  "accounts": [
    {
      "id": XXXXXX,
      "name": "Sample Account",
      "status": "pending",
      "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
      "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
      "browser_monitoring_key": "66617123f5",
      "allow_api_access": true,
      "high_security": false,
      "testing": null,
      "partner_external_identifier": null,
      "subscription": {
        "id": XXXXXX,
        "starts_on": "2016-05-17",
        "expires_on": null,
        "annual_renewal_on": null,
        "products": [
          {
            "product_id": 4,
            "name": "Pro",
            "units": 10,
            "price": 1990.0
          },
          {
            "product_id": 10,
            "name": "Mobile Lite",
            "units": null,
            "price": 0.0
          },
          {
            "product_id": 20,
            "name": "Browser Lite",
            "units": 0,
            "price": 0.0
          },
          {
            "product_id": 16,
            "name": "Insights None",
            "units": 0,
            "price": 0.0
          },
          {
            "product_id": 23,
            "name": "Synthetics Lite",
            "units": 0,
            "price": 0.0
          }
        ]
      },
      "primary admin": {
        "id": XXXXXX,
        "email": "sample_user@sample.org",
        "first_name": "Sample",
        "last_name": "User",
        "state": "active"
      }
    }
  ]
}

Pedido:

curl -X GET \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

Respuesta (los saltos de línea son para facilitar la lectura):

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": 00000,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

A continuación se muestra un ejemplo de cómo crear una cuenta para una organización en nuestro modelo de precios original y en nuestro modelo de usuario original. Para ver un ejemplo de llamada para crear una cuenta para una organización con los modelos más nuevos, consulte el ejemplo siguiente a este.

curl -X POST \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"account":{"name":"Sample Account", "users":[{"email":"sample_user@sample.org", "password":"XXXXXX", "first_name":"Sample", "last_name":"User", "role":"admin", "owner":"true"}],"subscriptions":[{"product_id": 4,"quantity": 10},{"product_id": 10,"quantity": 0}]}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/

Respuesta (los saltos de línea son para facilitar la lectura):

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

A continuación se muestra un ejemplo de creación de una cuenta para una asociación de clientes que se encuentra en nuestro modelo de precios basado en el uso y que tiene un usuario en nuestro modelo de usuario más nuevo. Para obtener más información sobre las restricciones en el uso de API, consulte los requisitos.

curl -X POST \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY'   \
    -H 'Content-Type:application/json'  \
    -d '{"account":{"name":"Sample account"}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/

Solo puede utilizar el objeto de cuenta de la API de asociación para actualizar los valores name, phone_number, testing y allow_API_access . Para actualizar los valores subscription y users , debe utilizar el objeto de suscripción de Partnership API y el objeto de usuario de Partnership API.

Pedido:

curl -X PUT \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"account":{"name":"Sample account name"}}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

Respuesta (los saltos de línea son para facilitar la lectura):

{
  "id": XXXXXX,
  "name": "Account New Name",
  "status": "pending",
  "license_key": "caf8247360d8db295c142c72138fa8fb28df1403",
  "api_key": "86f818b6d81668b6c034661396b71c25bb323d8b8df1403",
  "browser_monitoring_key": "66617123f5",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "subscription": {
    "id": XXXXXX,
    "starts_on": "2016-05-17",
    "expires_on": null,
    "annual_renewal_on": null,
    "products": [
      {
        "product_id": 4,
        "name": "Pro",
        "units": 10,
        "price": 1999.0
      },
      {
        "product_id": 10,
        "name": "Mobile Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 20,
        "name": "Browser Lite",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 16,
        "name": "Insights None",
        "units": 0,
        "price": 0.0
      },
      {
        "product_id": 23,
        "name": "Synthetics Lite",
        "units": 0,
        "price": 0.0
      }
    ]
  },
  "primary admin": {
    "id": XXXXXX,
    "email": "sample_user@sample.org",
    "first_name": "Sample",
    "last_name": "User",
    "state": "active"
  }
}

Pedido:

curl -X DELETE \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID

Respuesta: Sin cuerpo de respuesta.

Te ofrecemos esta traducción automática para facilitar la lectura.

Requisitos

Atributo de objeto de cuenta

nombre (REQUERIDO para crear una cuenta)

phone_number

allow_api_access

pruebas

usuario (REQUERIDO para algunas cuentas)

suscripción (REQUERIDA para algunas cuentas)

Importante

API de llamada de cuenta

Definiciones de estado

Ejemplo JSON

Solicitud JSON de objeto de cuenta

Respuesta JSON

Ejemplos de API de objetos de cuenta

Lista

Espectáculo

Crear

Actualizar

Borrar

Te ofrecemos esta traducción automática para facilitar la lectura.

Objeto de cuenta API de asociación

Requisitos .css-21sua1{background:none;border:none;width:0;padding:0;}

Atributo de objeto de cuenta

phone_number

allow_api_access

pruebas

usuario (REQUERIDO para algunas cuentas)

suscripción (REQUERIDA para algunas cuentas)

API de llamada de cuenta

Definiciones de estado

Ejemplo JSON

Solicitud JSON de objeto de cuenta

Respuesta JSON

Ejemplos de API de objetos de cuenta

Lista

Espectáculo

Crear

Actualizar

Borrar

Requisitos