Objeto de conta da API de parceria

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

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.
Você pode não ter acesso para usar este objeto específico. Antes de usar, primeiro leia os requisitos.

Atributo de objeto de conta

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

Tipo:	Corda
Padrão:	(nenhum)

O atributo de nome da conta é required para novas contas.

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: Quando você cria uma conta pela primeira vez, este campo é obrigatório e apenas um usuário pode ser definido: a conta Owner. Para adicionar usuários adicionais, use o objeto usuário API de Parceria.
Para obter mais informações sobre restrições, leia os Requisitos.

Tipo:	Matriz
Padrão:	(nenhum)

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

Para parcerias com clientes em nosso modelo de precificação baseado no uso: ignore este campo porque ele se aplica ao modelo de precificação original, não ao seu. Se você usar isso, ele será ignorado.
Para todas as outras contas: você segue nosso modelo original de precificação baseado em produto. O atributo subscriptions é required para novas contas. Se estiver vazio, será utilizado o nível padrão do produto. Para atualizar as informações de assinatura, use o objeto de assinatura da API de Parceria.
Importante
Ao criar uma conta com este objeto, pode levar algum tempo para que as configurações da conta sejam preenchidas. Isso significa que a resposta retornada pode inicialmente mostrar aspectos que não são verdadeiros (por exemplo, pode retornar uma resposta mostrando a assinatura Lite padrão).
Para especificar uma matriz JSON vazia, não use subscriptions: [ {} ]. Em vez disso, use este formato:
```
subscriptions: [  ]
```

A API da conta não inclui um atributo para criar uma conta infantil. Em vez disso, para criar contas filhas, use a páginaAccount settings da conta pai na interface do New Relic .

Chamada de conta da API

Aqui estão os padrões de URL para funções de API de conta. Se estiver usando esse padrão de URL, envie um cabeçalho HTTP contendo a chave de API do parceiro junto com o corpo da solicitação JSON. Por exemplo:

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

{ JSON data }

Chamar	Padrão de URL de recurso
Liste (index) todas as contas de um parceiro.	`GET /api/v2/partners/PARTNER_ID/accounts`
Show o atributo de uma conta.	`GET /api/v2/partners/PARTNER_ID/accounts/:ID`
Update o atributo de uma conta.	`PUT /api/v2/partners/PARTNER_ID/accounts/:ID`
Create uma conta com o parâmetro fornecido.	`POST /api/v2/partners/PARTNER_ID/accounts`
Cancel uma conta.	`DELETE /api/v2/partners/PARTNER_ID/accounts/:ID`

Definições de status

Quando uma conta é criada ou listada com uma chamada de API, o status da conta é incluído automaticamente. Alguns desses status não se aplicam a todos os modelos de preços.

Status da Conta	Definição
`pending`	Conta gratuita criada, mas o administrador principal ainda não está ativado.
`paid_pending`	Conta criada com uma assinatura paga, mas o administrador principal ainda não está ativado.
`new`	Conta gratuita, administrador principal ativo, nenhum dado do aplicativo foi coletado.
`paid_new`	Assinatura paga, administrador principal ativo, nenhum dado do aplicativo foi coletado.
`active`	Assinatura gratuita, recebendo dados do aplicativo.
`paid_active`	Assinatura paga, recebendo dados do aplicativo.
`upgraded`	A assinatura da conta foi atualizada.
`downgraded`	A assinatura da conta sofreu downgrade.
`cancelled`	A assinatura da conta New Relic foi cancelada.
`suspended`	A conta New Relic foi suspensa porque o administrador principal não validou seu endereço de e-mail.

Exemplo JSON

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

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"
  }
}

Exemplos de API de objeto de conta

Parcerias com mais de 1.000 contas retornam uma resposta paginada. Para especificar uma página, adicione o seguinte parâmetro à consulta:

?page=

Aqui estão exemplos de chamadas usando o objeto de conta da API de parceria. Note that these are examples, and that for some accounts, the users and subscriptions attributes don't apply and will be ignored.

Solicitação 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

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

{
  "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"
      }
    }
  ]
}

Solicitar:

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

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

{
  "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"
  }
}

Aqui está um exemplo de criação de uma conta para uma organização em nosso modelo de preços original e em nosso modelo de usuário original. Para um exemplo de criação de uma conta para organização com os modelos mais recentes, veja o exemplo a seguir 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/

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

{
  "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"
  }
}

Aqui está um exemplo de criação de uma conta para uma parceria de clientes que está em nosso modelo de precificação baseado em uso e que tem usuário em nosso modelo de usuário mais recente. Para obter mais informações sobre restrições ao uso da API, consulte 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/

Você só pode usar o objeto de conta da API Partnership para atualizar os valores name, phone_number, testing e allow_API_access . Para atualizar os valores subscription e users , você deve usar o objeto de assinatura da API Partnership e o objeto de usuário da API Partnership.

Solicitar:

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

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

{
  "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"
  }
}

Solicitar:

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

Resposta: Nenhum corpo de resposta.

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

Requisitos

Atributo de objeto de conta

nome (NECESSÁRIO para criar uma conta)

phone_number

allow_api_access

testando

usuário (OBRIGATÓRIO para algumas contas)

assinatura (OBRIGATÓRIA para algumas contas)

Importante

Chamada de conta da API

Definições de status

Exemplo JSON

Solicitação JSON do objeto de conta

Resposta JSON

Exemplos de API de objeto de conta

Lista

Mostrar

Criar

Atualizar

Excluir

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

Objeto de conta da API de parceria

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

Atributo de objeto de conta

phone_number

allow_api_access

testando

usuário (OBRIGATÓRIO para algumas contas)

assinatura (OBRIGATÓRIA para algumas contas)

Chamada de conta da API

Definições de status

Exemplo JSON

Solicitação JSON do objeto de conta

Resposta JSON

Exemplos de API de objeto de conta

Lista

Mostrar

Criar

Atualizar

Excluir

Requisitos