Objeto de conta secundária da API de parceria

Este documento explica como usar a API Partnership para gerenciar contas infantis. Para contas pai, você usaria o objeto conta .

Requisitos

Antes de usar esta API, observe:

Esta API não está disponível para você, a menos que sua organização tenha sido instruída por um representante da New Relic para usá-la.
Talvez você não tenha acesso para usar esse objeto de API específico. Antes de usar, primeiro leia os requisitos.

Introdução ao uso de contas infantis

Algumas notas sobre o uso do objeto conta infantil:

Para gerenciar contas principais ou filhas existentes, use o objeto de conta da API de parceria.
Uma conta pai pode ter mais de uma conta infantil associada, mas cada conta infantil deve corresponder a uma e somente uma conta pai.
Cada conta infantil deve ter pelo menos um usuário primary_admin .
Você não pode criar uma conta infantil sem conectá-la a uma conta pai existente e adicionar pelo menos um usuário.

Atributo de objeto de conta infantil

Before using the Partnership API, first read the requirements.

Aqui estão os atributos do objeto de conta infantil API de Parceria:

Tipo:	Corda
Padrão:	(nenhum)

Este nome deve ser exclusivo no banco de dados da New Relic. Se o nome especificado não for exclusivo, ele será incrementado automaticamente com um sufixo numérico da seguinte forma:

conflicting_name_1
conflicting_name_2
etc.

Tipo:	Boleano
Padrão:	Falso

Use este sinalizador para indicar uma conta de teste. Presume-se que as contas de teste contenham dados inúteis e sejam ignoradas pelos sistemas internos. Os dados que eles geram podem ser excluídos a qualquer momento.

Tipo:	Matriz
Padrão:	(nenhum)

Uma matriz definindo uma lista de usuários. Existem algumas restrições em vigor dependendo do status da sua conta:

Para parcerias de clientes que migraram seu usuário para nosso modelo de usuário mais recente: não defina usuário. Se você adicionar usuário com este campo, eles serão ignorados. Em vez disso, para adicionar usuários, você usaria estes procedimentos de gerenciamento de usuários.
Para todas as outras contas que possuem usuário em nosso modelo de usuário original: Ao criar a conta filha, você pode definir apenas um usuário: a conta Owner. Para adicionar usuários adicionais, use o objeto usuário API de Parceria.
Para mais informações sobre restrições, leia os Requisitos.

Para algumas organizações New Relic , contas de crianças também podem ser criadas através da páginaAccount settings da conta dos pais na interface da New Relic .

Chamada de API de conta infantil

Aqui está o padrão de URL para criar contas filhas. Observe que o ID da conta pai deve ser especificado. Se estiver usando esse padrão de URL, envie o objeto JSON junto com um cabeçalho HTTP contendo a chave de API do parceiro. Por exemplo:

POST .../api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

Chamar	Padrão de URL de recurso
Create uma conta infantil com o parâmetro fornecido.	`POST /api/v2/partners/PARTNER_ID/accounts/PARENT_ACCOUNT_ID/sub_accounts`

Exemplo JSON

Aqui está um exemplo de solicitação e resposta JSON usando o objeto de conta infantil da API de Parceria.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

{
  "sub_account": {
    "name": "Sample child account",
    "allow_api_access": true
  },
  "users": [
    {
      "email": "sample_user@sample.org",
      "password": "XXXXXXXX",
      "first_name": "Sample",
      "last_name": "User",
      "role": "admin",
      "owner": "true"
    }
  ]
}

{
  "id": XXXXXX,
  "name": "Sample Account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": true,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "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"
  }
}

Exemplos de API de objeto de conta infantil

Aqui está um exemplo de uma chamada de API usando o objeto de conta secundária da API de parceria.

Note that this is just an example, and that for some accounts, the users attribute is unnecessary and will be ignored.

Solicitar:

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

Resposta (quebras de linha são para facilitar a leitura):

{
  "id": XXXXXX,
  "name": "Sample child account",
  "status": "pending",
  "license_key": "XXXXXX",
  "api_key": "XXXXXX",
  "browser_monitoring_key": "XXXXXX",
  "allow_api_access": false,
  "high_security": false,
  "testing": null,
  "partner_external_identifier": null,
  "parent_account_id":XXXXXX,
  "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"
  }
}

Esta tradução de máquina é fornecida para sua comodidade.

Objeto de conta secundária da API de parceria

Requisitos

Introdução ao uso de contas infantis

Atributo de objeto de conta infantil

nome (OBRIGATÓRIO)

allow_api_access

testando

usuário (OBRIGATÓRIO para algumas contas)

Senha requerida)

Chamada de API de conta infantil

Exemplo JSON

Solicitação JSON de objeto de conta filha

Resposta JSON

Exemplos de API de objeto de conta infantil

Criar

Esta tradução de máquina é fornecida para sua comodidade.

Objeto de conta secundária da API de parceria

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

Introdução ao uso de contas infantis

Atributo de objeto de conta infantil

allow_api_access

testando

usuário (OBRIGATÓRIO para algumas contas)

Senha requerida)

Chamada de API de conta infantil

Exemplo JSON

Solicitação JSON de objeto de conta filha

Resposta JSON

Exemplos de API de objeto de conta infantil

Criar

Requisitos