Endpoint de configurações de aplicativo

AVISO

A implementação do endpoint /app_configurations ocorre em fluxo, à medida que os recursos são adicionados, removidos e retrabalhados.

As configurações de aplicativo permitem que as credenciais sejam armazenadas e recuperadas para uso posterior. O endpoint /app_configurations na API do Reactor permite gerenciar de forma programática as configurações de aplicativo em seu aplicativo de experiência.

Introdução

O endpoint usado neste manual faz parte da API do Reactor. Antes de continuar, consulte o guia de introdução para obter informações importantes sobre como realizar a autenticação na API.

Recuperar uma lista de configurações de aplicativo

Formato da API

GET /companies/{COMPANY_ID}/app_configurations
Parâmetro Descrição
COMPANY_ID O id da empresa proprietária das configurações de aplicativo.
OBSERVAÇÃO

Usando parâmetros de consulta, as configurações de aplicativo listadas podem ser filtradas com base nos seguintes atributos:

  • app_id
  • created_at
  • key_type
  • messaging_service
  • name
  • platform
  • updated_at
Consulte o manual sobre filtragem de respostas para obter mais informações.

Solicitação

curl -X GET \
  https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/app_configurations \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Resposta

Uma resposta de êxito retorna uma lista de configurações de aplicativo.

{
  "data": [
    {
      "id": "AC40c339ab80d24c958b90d67b698602eb",
      "type": "app_configurations",
      "attributes": {
        "created_at": "2020-12-14T17:31:10.626Z",
        "updated_at": "2020-12-14T17:31:10.626Z",
        "app_id": "com.adobe.test_app",
        "name": "Kessel Apns App",
        "platform": "mobile",
        "messaging_service": "apns",
        "key_type": "p8_file"
      },
      "relationships": {
        "company": {
          "links": {
            "related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
          },
          "data": {
            "id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
            "type": "companies"
          }
        }
      },
      "links": {
        "company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
        "self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "prev_page": null,
      "total_pages": 1,
      "total_count": 1
    }
  }
}

Pesquisar uma configuração de aplicativo

É possível pesquisar uma configuração de aplicativo informando a respectiva ID no caminho de uma solicitação GET.

Formato de API

GET /app_configurations/{APP_CONFIGURATION_ID}
Parâmetro Descrição
APP_CONFIGURATION_ID A id da configuração de aplicativo que você deseja pesquisar.

Solicitação

curl -X GET \
  https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Resposta

Uma resposta bem-sucedida retorna os detalhes da configuração de aplicativo.

{
  "data": {
    "id": "AC40c339ab80d24c958b90d67b698602eb",
    "type": "app_configurations",
    "attributes": {
      "created_at": "2020-12-14T17:31:10.626Z",
      "updated_at": "2020-12-14T17:31:10.626Z",
      "app_id": "com.adobe.test_app",
      "name": "Kessel Apns App",
      "platform": "mobile",
      "messaging_service": "apns",
      "key_type": "p8_file"
    },
    "relationships": {
      "company": {
        "links": {
          "related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
        },
        "data": {
          "id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
          "type": "companies"
        }
      }
    },
    "links": {
      "company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
      "self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
    }
  }
}

Criar uma configuração de aplicativo

É possível criar uma nova configuração de aplicativo fazendo uma solicitação POST.

Formato da API

POST /companies/{COMPANY_ID}/app_configurations
Parâmetro Descrição
COMPANY_ID A id da empresa em que a configuração de aplicativo está sendo definida.

Solicitação

curl -X POST \
  https://reactor.adobe.io/companies \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -d '{
        "data": {
          "attributes": {
            "name": "Kessel Apns App",
            "app_id": "com.adobe.test_app",
            "platform": "mobile",
            "messaging_service": "apns",
            "key_type": "p8_file",
            "push_credential": {
              "bundleId": "com.adobe.test_app",
              "keyId": "{KEY_ID}",
              "p8": "{SECRET}",
              "teamId": "{TEAM_ID}"
            }
          },
          "type": "app_configurations"
        }
      }'
Propriedade Descrição
platform A plataforma em que o aplicativo é executado (web ou móvel). Isso determina quais serviços de mensagens estão disponíveis.
messaging_service O serviço de mensagens associado ao aplicativo, como o Serviço de notificação por push da Apple (APNs) e o Firebase Cloud Messaging (FCM). Isso determina quais tipos de chave podem ser usados.
key_type Representa o protocolo ao qual um fornecedor de serviços por push dá suporte e determina o formato do objeto push_credential. À medida que os protocolos evoluem para serviços de mensagens, novos valores key_type são criados para dar suporte aos protocolos atualizados.
push_credential O valor real da credencial, que é criptografado em repouso. Normalmente, esse campo não é descriptografado nem incluído nas respostas da API. Somente alguns serviços da Adobe podem obter uma resposta que contém uma credencial de push descriptografada.

Resposta

Uma resposta bem-sucedida retorna os detalhes da configuração do aplicativo recém-criado.

{
  "data": {
    "id": "AC40c339ab80d24c958b90d67b698602eb",
    "type": "app_configurations",
    "attributes": {
      "created_at": "2020-12-14T17:31:10.626Z",
      "updated_at": "2020-12-14T17:31:10.626Z",
      "app_id": "com.adobe.test_app",
      "name": "Kessel Apns App",
      "platform": "mobile",
      "messaging_service": "apns",
      "key_type": "p8_file"
    },
    "relationships": {
      "company": {
        "links": {
          "related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
        },
        "data": {
          "id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
          "type": "companies"
        }
      }
    },
    "links": {
      "company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
      "self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
    }
  }
}

Atualizar uma configuração de aplicativo

Você pode atualizar uma configuração de aplicativo incluindo a respectiva ID no caminho de uma solicitação PATCH.

Formato da API

PATCH /app_configurations/{APP_CONFIGURATION_ID}
Parâmetro Descrição
APP_CONFIGURATION_ID A id da configuração de aplicativo que você deseja atualizar.

Solicitação

A solicitação a seguir atualiza o app_id de uma configuração de aplicativo existente.

curl -X PATCH \
  https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -d '{
        "data": {
          "attributes": {
            "app_id": "com.adobe.test_app_2"
          },
          "id": "AC40c339ab80d24c958b90d67b698602eb",
          "type": "app_configurations"
        }
      }'
Propriedade Descrição
attributes Um objeto cujas propriedades representam os atributos a serem atualizados para a configuração de aplicativo. Cada chave representa o atributo da configuração de aplicativo específico a ser atualizado, juntamente com o valor correspondente para o qual ele deve ser atualizado.

Os seguintes atributos podem ser atualizados para configurações de aplicativo:
  • app_id
  • key_type
  • messaging_service
  • name
  • platform
  • push_credential
id A id da configuração de aplicativo que você deseja atualizar. Isso deve corresponder ao valor {APP_CONFIGURATION_ID} informado no caminho da solicitação.
type O tipo de recurso que está sendo atualizado. Para esse endpoint, o valor deve ser app_configurations.

Resposta

Uma resposta bem-sucedida retorna os detalhes da configuração de aplicativo atualizada.

{
  "data": {
    "id": "AC40c339ab80d24c958b90d67b698602eb",
    "type": "app_configurations",
    "attributes": {
      "created_at": "2020-12-14T17:31:10.626Z",
      "updated_at": "2020-12-14T17:31:21.787Z",
      "app_id": "com.adobe.test_app_2",
      "name": "Kessel Apns App",
      "platform": "mobile",
      "messaging_service": "apns",
      "key_type": "p8_file"
    },
    "relationships": {
      "company": {
        "links": {
          "related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
        },
        "data": {
          "id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
          "type": "companies"
        }
      }
    },
    "links": {
      "company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
      "self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
    }
  }
}

Excluir uma configuração de aplicativo

Você pode excluir uma configuração de aplicativo incluindo a respectiva ID no caminho de uma solicitação DELETE.

Formato de API

DELETE /app_configurations/{APP_CONFIGURATION_ID}
Parâmetro Descrição
APP_CONFIGURATION_ID A id da configuração de aplicativo que você deseja excluir.

Solicitação

curl -X DELETE \
  https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H "Content-Type: application/vnd.api+json" \
  -H 'Accept: application/vnd.api+json;revision=1'

Resposta

Uma resposta bem-sucedida retorna o status HTTP 204 (Sem conteúdo) sem corpo de resposta, indicando que a configuração do aplicativo foi excluída.

Nesta página