Device Groups

Por meio da API do Content Delivery você pode consultar, criar, remover ou atualizar suas configurações. Para gerenciamento de Device Groups (requer o produto Adaptive Delivery), utilize os endpoints que seguem.


1. Consultar lista de grupos de dispositivos

Retorna a lista de grupos de dispositivos de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/device_groups

Permissão necessária: View Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery a ser consultada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number

Exemplo de Requisição

GET /content_delivery/configurations/1492081095/device_groups
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

Exemplo de Resposta

HTTP/2 200
[
   {
      "id": 314,
      "name": "Mobile","user_agent":"(Mobile|iP(hone|od)|BlackBerry|IEMobile|Kindle|NetFront|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dol(f|ph)in|Skyfire|Zune)"
   },
   {
      "id": 321,
      "name": "Tablet","user_agent":"(Tablet|iPad|Silk)"
   }
]

2. Consultar dados de um grupo de dispositivos

Retorna dados de um grupo de dispositivos de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/device_groups/:device_id

Permissão necessária: View Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery a ser consultada. Para obter o Id de uma configuração, consulte a Lista de Configurações. path number
:device_id

(obrigatório)
Id do grupo de dispositivos a ser consultado. Para obter o Id de um grupo de dispositivos, consulte a Lista de Grupos de Dispositivos. path number

Exemplo de Requisição

GET /content_delivery/configurations/1492081095/device_groups/314
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

Exemplo de Resposta

HTTP/2 200
{
    "id": 314,
    "name": "Mobile",
    "user_agent": "(Mobile|iP(hone|od)|BlackBerry|IEMobile|Kindle|NetFront|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dol(f|ph)in|Skyfire|Zune)"
 } 

3. Deletar um grupo de dispositivos

DELETE /content_delivery/configurations/:conf_id/device_groups/:device_id

Remove um grupo de dispositivos de uma configuração de Content Delivery. O grupo não pode estar em uso para ser removido.

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery que possui a origem que será removida.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:device_id

(obrigatório)
Id do grupo de dispositivos a ser removido.
Para obter o Id de um grupo de dispositivos, consulte a Lista de Grupos de Dispositivos.
path number

Exemplo de Requisição

DELETE /content_delivery/configurations/1492081095/device_groups/321
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

Exemplo de Resposta

HTTP/2 204

4. Criar um novo grupo de dispositivos

Cria um novo grupo de dispositivos em uma configuração de Content Delivery.

POST /content_delivery/configurations/:conf_id/device_groups

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
Content-Type

(obrigatório)
O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery para a qual a origem deve ser criada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
Device Group

(obrigatório)
O grupo de dispositivos que se deseja criar deve ser enviado codificado no formato json com os seguintes campos:

  • name (string): campo obrigatório que define um nome para o grupo de dispositivos.
  • user_agent (string): expressão regular sobre o cabeçalho User Agent para detecção do grupo de dispositivos.
body json

Exemplo de Requisição

POST /content_delivery/configurations/1492081095/device_groups
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
Content-Type: application/json
{
    "name": "Tablet",
    "user_agent": "(Tablet|iPad|Silk)"
 } 

Exemplo de Resposta

HTTP/2 201
{
    "id": 322,
    "name": "Tablet",
    "user_agent": "(Tablet|iPad|Silk)"
 } 

5. Sobrescrever um grupo de dispositivos

Sobrescreve todos os campos de um grupo de dispositivos, preservando o id. Considere utilizar o método PATCH no lugar de PUT, para atualizar somente alguns campos da configuração sem alterar o valor dos demais.

PUT /content_delivery/configurations/:conf_id/device_groups/:device_id

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
Content-Type

(obrigatório)
O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery para a qual a Origem deve ser substituída.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:device_id

(obrigatório)
Id do grupo de dispositivos a ser sobrescrito. Para obter o Id de uma configuração, consulte a Lista de Grupos de Dispositivos. path number
Device Group

(obrigatório)
O grupo de dispositivos que se deseja sobrescrever deve ser enviado codificado no formato json com os seguintes campos:

  • name (string): define um nome para o grupo de dispositivos.
  • user_agent (string): expressão regular sobre o cabeçalho User Agent para detecção do grupo de dispositivos.
body json

Exemplo de Requisição

PUT /content_delivery/configurations/1492081095/device_groups/314
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
Content-Type: application/json
{
    "name": "Mobile",
    "user_agent": "(Mobile|iP(hone|od)|BlackBerry|IEMobile|Opera M(obi|ini))"
 } 

Exemplo de Resposta

HTTP/2 200
{
    "id": 314,
    "name": "Mobile",
    "user_agent": "(Mobile|iP(hone|od)|BlackBerry|IEMobile|Opera M(obi|ini))"
} 

6. Atualizar campos de um grupo de dispositivos

Atualiza um ou mais campos de um grupo de dispositivos em uma configuração de Content Delivery, preservando o valor dos campos não informados.

PATCH /content_delivery/configurations/:conf_id/device_groups/:device_id

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)
A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
header string
Content-Type

(obrigatório)
O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json
header string
:conf_id

(obrigatório)
Id da configuração de Content Delivery para a qual a origem deve ser atualizada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:device_id

(obrigatório)
Id do grupo de dispositivos a ser atualizado Para obter o Id de um grupo de dispositivos, consulte a Lista de Grupos de Dispositivos. path number
Device Group

(obrigatório)
Os campos do grupo de dispositivos que se deseja atualizar devem ser enviados codificados no formato json:

  • name (string): define um nome para o grupo de dispositivos.
  • user_agent (string): expressão regular sobre o cabeçalho User Agent para detecção do grupo de dispositivos.
body json

Exemplo de Requisição

PATCH /content_delivery/configurations/1492081095/device_groups/322
Accept: application/json; version=1
Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf
Content-Type: application/json
{
    "user_agent": "(Tablet|iPad|Kindle)"
} 

Exemplo de Resposta

HTTP/2 200
{
    "id": 322,
    "name": "Tablet",
    "user_agent": "(Tablet|iPad|Kindle)"
 } 

Não encontrou o que procurava? Abra um ticket.