Etapa 3: enviar solicitações adicionais - Amazon Pinpoint

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Etapa 3: enviar solicitações adicionais

Ao terminar de configurar e testar o Postman, você poderá começar a enviar solicitações adicionais para a API do Amazon Pinpoint. Esta seção inclui informações que você precisa saber antes de iniciar o envio de solicitações. Isso também inclui dois exemplos de solicitações que descrevem como usar a coleção Amazon Pinpoint.

Importante

Ao concluir os procedimentos desta seção, você enviará solicitações para a API do Amazon Pinpoint. Essas solicitações criam recursos em sua conta do Amazon Pinpoint, modificam recursos existentes, enviam mensagens, alteram a configuração de seus projetos do Amazon Pinpoint e usam outros recursos do Amazon Pinpoint. Tenha cuidado ao executar essas solicitações.

Você precisa configurar a maioria das operações na coleção do Amazon Pinpoint Postman para usá-las. Para as operações GET e DELETE, normalmente, você só precisa modificar as variáveis definidas na guia Pre-request Script (Script de pré-solicitação).

nota

Ao usar a política do IAM mostrada em Criar uma política do IAM, você não pode realizar nenhuma das DELETE solicitações incluídas nessa coleção.

Por exemplo, a operação GetCampaign exige que você especifique um projectId e um campaignId. Na guia Pre-request Script (Script de pré-solicitação), essas variáveis estão presentes e são preenchidas com valores de exemplo. Exclua os valores de exemplo e substitua-os pelos valores apropriados para a campanha e o projeto do Amazon Pinpoint.

Dessas variáveis, a mais comumente usada é a variável projectId. O valor dessa variável deve ser o identificador exclusivo para o projeto ao qual sua solicitação se aplica. Para obter uma lista desses identificadores para seus projetos, consulte a resposta à solicitação GetApps que você enviou na etapa anterior deste tutorial. Nessa resposta, o campo Id fornece o identificador exclusivo de um projeto. Para saber mais sobre a operação GetApps e o significado de cada campo na resposta, consulte Aplicativos na Referência de API do Amazon Pinpoint.

nota

No Amazon Pinpoint, um “projeto” é o mesmo que um “app” ou “aplicativo”.

Para as operações POST e PUT, você também precisa modificar o corpo da solicitação para incluir os valores que você deseja enviar para a API. Por exemplo, quando envia uma solicitação CreateApp, que é uma solicitação POST, é necessário especificar um nome para o projeto que você criar. É possível modificar a solicitação na guia Body (Corpo). Neste exemplo, substitua o valor ao lado de "Name" pelo nome do projeto. Se quiser adicionar tags ao projeto, especifique-os no objeto tags. Ou, se não desejar adicionar tags, exclua todo o objeto tags.

nota

A operação UntagResource também exige que você especifique parâmetros de URL. Você pode especificar esses parâmetros na guia Params (Parâmetros). Substitua os valores na coluna VALUE (Valor) pelas tags que você deseja excluir para o recurso especificado.

Antes de criar segmentos e campanhas no Amazon Pinpoint, primeiro você precisa criar um projeto. No Amazon Pinpoint, um projeto consiste em segmentos, campanhas, configurações e dados unidos por um propósito comum. Por exemplo, você pode usar um projeto para conter todo o conteúdo relacionado a um determinado aplicativo ou a uma marca ou iniciativa de marketing específica. Quando você adiciona informações do cliente ao Amazon Pinpoint, essas informações são associadas a um projeto.

Para criar um projeto enviando uma solicitação de CreateApp API

  1. No menu Ambientes, escolha Região da AWS aquele em que você deseja criar o projeto.

    O menu Ambientes aberto mostrando as Regiões disponíveis.

    Neste exemplo, o Postman foi configurado para que o menu Environments (Ambientes) mostre as quatro opções a seguir:

    • Leste dos EUA (Norte da Virgínia)

    • Oeste dos EUA (Oregon)

    • Europa (Frankfurt)

    • Europa (Irlanda)

  2. Na pasta Apps, escolha a CreateAppoperação>.

    A pasta Aplicativos na coleção do Amazon Pinpoint Postman.

    A pasta Aplicativos na coleção Amazon Pinpoint Postman foi expandida e mostra as seguintes solicitações:

    • GetApp

    • GetApps

    • CreateApp

    • DeleteApp

  3. Na guia Body (Corpo), ao lado de "Name", substitua o valor do espaço reservado ("string") por um nome para a campanha, como "MySampleProject".

  4. Exclua a vírgula depois do nome da campanha e, depois, exclua o objeto tags inteiro nas linhas de 3 a 5. Ao terminar, sua solicitação deverá se parecer com o exemplo mostrado no trecho de código a seguir.

    {
    "Name": "MySampleProject"
}

    O Postman é configurado para enviar a solicitação como uma carga JSON bruta.

  5. Selecione Enviar. Se a campanha for criada com êxito, o painel de resposta mostrará o status 201 Created.

    {
    "Name": "MySampleProject"
    "Id": "12345678901234567890123456789012",
    "Arn": "arn:aws:mobiletargeting:us-east-1:123456789012:apps/12345678901234567890123456789012",
    "tags": {}
}

É muito comum usar a API SendMessages do Amazon Pinpoint para enviar mensagens transacionais. Uma vantagem de enviar mensagens usando a API SendMessages em vez de criar campanhas é que você pode usar a API para enviar mensagens para qualquer endereço, como um endereço de e-mail, número de telefone ou token de dispositivo. O endereço para o qual você enviar mensagens não precisa existir em sua conta do Amazon Pinpoint. Compare esse método com o envio de mensagens por meio da criação de campanhas. Antes de enviar uma campanha no Amazon Pinpoint, você deve adicionar endpoints à sua conta do Amazon Pinpoint, criar segmentos, criar a campanha e realizar a campanha.

O exemplo nesta seção mostra como enviar uma mensagem de e-mail transacional diretamente para um determinado endereço de e-mail. Você pode modificar essa solicitação para enviar mensagens por meio de outros canais, como SMS, push ou voz para dispositivos móveis.

Para enviar uma mensagem de e-mail enviando uma SendMessages solicitação

  1. Verifique se o canal de e-mail está habilitado para o projeto e se o endereço de e-mail ou domínio que você deseja usar para enviar e receber a mensagem está configurado. Para obter mais informações, consulte Ativação e desativação do canal de e-mail e Verificação de identidades de e-mail no Guia do usuário do Amazon Pinpoint.

    nota

    Para concluir o procedimento desta seção, você precisa verificar um endereço de e-mail

  2. No menu Ambientes, escolha Região da AWS aquele do qual você deseja enviar a mensagem.

    Neste exemplo, o Postman foi configurado para que o menu Environments (Ambientes) mostre as quatro opções a seguir:

    • Leste dos EUA (Norte da Virgínia)

    • Oeste dos EUA (Oregon)

    • Europa (Frankfurt)

    • Europa (Irlanda)

  3. Na pasta Mensagens, escolha a SendMessagesoperação.

    A pasta Mensagens na coleção do Amazon Pinpoint Postman. O conteúdo da pasta é expandido e as SendUsersMessages solicitações SendMessages e são mostradas.

  4. Na guia Pre-request Script (Script de pré-solicitação), substitua o valor da variável projectId pelo ID de um projeto que já existe na região que você selecionou na etapa 2 desta seção.

  5. Na guia Body (Corpo), exclua a solicitação de exemplo que é mostrada no editor de solicitações. Cole o seguinte código:

    {
    "MessageConfiguration":{
        "EmailMessage":{
            "FromAddress":"sender@example.com",
            "SimpleEmail":{
                "Subject":{
                    "Data":"Sample Amazon Pinpoint message"
                },
                "HtmlPart":{
                    "Data":"<h1>Test message</h1><p>This is a sample message sent from <a href=\"https://aws.amazon.com/pinpoint\">Amazon Pinpoint</a> using the SendMessages API.</p>"
                },
                "TextPart":{
                    "Data":"This is a sample message sent from Amazon Pinpoint using the SendMessages API."
                }
            }
        }
    },
    "Addresses":{
        "recipient@example.com": {
            "ChannelType": "EMAIL"
        }
    }
}

  6. No código anterior, substitua sender@example.com pelo endereço de e-mail verificado. Substitua recipient@example.com pelo endereço de e-mail verificado para o qual você deseja enviar a mensagem.

    nota

    Se sua conta ainda estiver na sandbox de e-mails do Amazon Pinpoint, você só poderá enviar e-mails de endereços ou domínios verificados na sua conta do Amazon Pinpoint. Para obter mais informações sobre como remover a conta da sandbox, consulte Solicitar acesso de produção para e-mail no no Guia do usuário do Amazon Pinpoint.

  7. Selecione Enviar. Se a mensagem for enviada com êxito, o painel de respostas mostrará o status 200 OK.

    {
    "ApplicationId": "12345678901234567890123456789012",
    "RequestId": "<sampleValue>",
    "Result": {
        "recipient@example.com": {
            "DeliveryStatus": "SUCCESSFUL",
            "StatusCode": 200,
            "StatusMessage": "<sampleValue>",
            "MessageId": "<sampleValue>"
        }
    }
}