Utilize a API de eventos em jornadas em tempo real

A API de eventos é um método programático para aceder a dados de eventos, sessões, faixas de sessão, passes, oradores e patrocínios. Além disso, a API de eventos permite inscrever-se em eventos e sessões.

A API acessada é pelo protocolo HTTPS e é acessada a partir do ponto de extremidade da API que você recebe ao criar um token de aplicativo Web. Todos os dados são enviados e recebidos como JSON.

Registe-se para a API de eventos

Na seção Configurações emAplicativos Web> eventos, crie um novo aplicativo Web. É importante selecionar a origem correta. Por exemplo, se você selecionar https://contoso.com, JavaScript hospedado em domínio diferente não poderá acessar a API de gerenciamento de eventos.

Captura de tela das configurações da API de eventos.

Depois de criar um aplicativo Web, você verá um link para a especificação OpenAPI na documentação do Endpoint (Visualização).

Captura de ecrã do endpoint da API de evento.

Pode selecionar o link e copiar e colar o contrato da API num editor OpenAPI como o Swagger Editor, que gera automaticamente um wrapper que pode usar para descobrir a sua API. Para acessar sua API, você deve estar autorizado (forneça a coluna Token ).

Captura de ecrã do Event API Swagger Editor.

Criar uma página de evento ou um portal de eventos

A API de eventos permite-lhe criar uma página de eventos personalizada e um portal de eventos que lista todos os eventos disponíveis que estejam ativos e publicados, utilizando a opção de publicação "Solução personalizada usando a API de eventos". A API de eventos permite-lhe:

  • Recupere uma lista de eventos ao vivo que inclua seu nome, descrição, local e hora.
  • Para a página do evento, ele permite que você recupere informações importantes sobre o evento, como:
    • Name
    • Time
    • Localização
    • Código QR do evento
    • Capacidade
    • Lista de sessões
    • Lista de oradores
    • Lista de patrocinadores e seus logotipos

Criar uma experiência de registo de eventos personalizada

A API de eventos também permite criar uma submissão de registo sem necessidade de usar formulários de marketing em tempo real, beneficiando ainda assim de funcionalidades importantes como estratégia de correspondência, consentimento, definições de audiência e muito mais.

Primeiro, defina as principais configurações para seu público navegando até Configurações>Gerenciamento de> eventosConfigurações Configurações de registro de eventos e defina:

  1. Público padrão
  2. Regra de correspondência padrão
  3. Perfil de conformidade padrão

As configurações padrão de registro de eventos são usadas ao processar envios da API. Depois de definir as definições de registo, o ponto final de submissão da API de eventos permite:

  1. Crie uma submissão de registo para um evento:
{ 
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                }, 
                { 
                    "id": "customUnmappedField1", 
                    "value": "Sample Custom Unmapped Field 1" 
                }, 
                { 
                    "id": "customUnmappedField2", 
                    "value": "Sample Custom Unmapped Field 2" 
                } 
            ] 
        } 
    ] 
}
  1. Criar uma submissão de inscrição para uma sessão:
{ 
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                } 
            ], 
            "attendeeSessions": [ 
                { 
                    "sessionId": "d5f513c6-989f-f011-bbd3-000d3a5b6385" 
                }, 
                { 
                    "sessionId": "f5d4e4b9-989f-f011-bbd3-000d3a5b6385" 
                } 
            ] 
        } 
    ] 
} 
  1. Crie um registo em lista de espera:
{
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "waitlisted": true, 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                }, 
                { 
                    "id": "customUnmappedField1", 
                    "value": "Sample Custom Unmapped Field 1" 
                }, 
                { 
                    "id": "customUnmappedField2", 
                    "value": "Sample Custom Unmapped Field 2" 
                } 
            ] 
        } 
    ]
}

Desempenho e limites

A API de eventos suporta cenários de registo de elevado volume através de processamento assíncrono, armazenamento em cache inteligente e lógica de repetição incorporada.

Quando um pedido de registo chega através da API do evento, o sistema:

  • Valida que o evento está ativo e que todas as entidades relacionadas estão num estado válido
  • Devolve uma resposta imediata de sucesso ao chamador.
  • Inicia um processador de itens de trabalho em segundo plano para criar o registo de eventos e as entidades associadas de forma assíncrona.

Comportamento de cache

Cache de leitura: O sistema aplica uma cache de 10 minutos para validação de eventos e entidades. Isto reduz leituras redundantes para o Dataverse e melhora o rendimento sob carga.

Note

A cache de leitura afeta apenas a validação, não os registos de registo em si.

Lógica de novas tentativas e tratamento de falhas

Se o processador em segundo plano falhar em criar um registo de eventos, o sistema tenta automaticamente durante até seis horas. Isto aplica-se a cenários de falha síncrona e assíncrona, garantindo a fiabilidade dos dados sem necessidade de intervenção manual.

Limites de débito e Dataverse

O principal fator limitante para cenários de registo sem forma é a taxa a que as entidades de registo de bilhetes podem ser criadas no Dataverse. Em condições normais, o Dataverse impõe um limite de 6.000 pedidos de API, dentro de uma janela deslizante de cinco minutos, por utilizador e servidor web. A plataforma pode devolver um 429 Too Many Requests erro se estes limites forem ultrapassados. Saiba mais: Limites da API de proteção de serviços.

Importante

Se o evento utilizar um gateway de pagamento, poderão aplicar-se passos adicionais de validação, e a taxa de processamento efetiva poderá ser inferior. Os clientes que utilizam gateways de pagamento devem validar o comportamento de cache para a sua configuração específica.