Usar a API de eventos em percursos em tempo real

A API de eventos é um método programático para acessar dados de eventos, sessões, trilhas de sessão, credenciais, palestrantes e patrocínios. Além disso, a API de eventos permite que você se registre para eventos e sessões.

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

Registrar-se para a API de eventos

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

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

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

Captura de tela do endpoint da API de eventos.

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

Captura de tela do Swagger Editor da API de Eventos.

Criar uma página de evento ou portal de eventos

A API de eventos permite que você crie uma página de eventos personalizada e um portal de eventos que lista todos os eventos disponíveis que são ao vivo e publicados usando a opção de publicação "Solução personalizada usando a API de eventos". A API de eventos permite que você:

  • Recupere uma lista de eventos ao vivo que incluem seu nome, descrição, localização e hora.
  • Para a página de eventos, ela permite que você recupere informações importantes sobre o evento, como:
    • Nome
    • Tempo
    • Localidade
    • Código QR de evento
    • Capacity
    • Lista de sessões
    • Lista de alto-falantes
    • Lista de patrocinadores e seus logotipos

Criar uma experiência de registro de evento personalizada

A API de eventos também permite que você crie um envio de registro sem a necessidade de usar formulários de marketing em tempo real, enquanto ainda se beneficia de recursos importantes, como estratégia de correspondência, consentimento, configurações de público e muito mais.

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

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

As configurações de registro de evento padrão são usadas ao processar envios da API. Depois de definir as configurações de registro, o endpoint de envio da API de eventos permite:

  1. Crie um envio de registro 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. Crie uma submissão de registro 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 registro de 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 dá suporte a cenários de registro de alto volume por meio de processamento assíncrono, cache inteligente e lógica de repetição interna.

Quando uma solicitação de registro chega por meio da API de evento, o sistema:

  • Valida se o evento está ativo e todas as entidades relacionadas estão em um estado válido
  • Retorna uma resposta de sucesso imediata para o chamador.
  • Inicia um processador de item de trabalho em segundo plano para criar o registro de evento e entidades associadas de forma assíncrona.

Comportamento de cache

Cache de leitura: o sistema aplica um cache de 10 minutos para validação de evento e entidade. Isso reduz as leituras redundantes para o Dataverse e melhora a taxa de transferência sob carga.

Note

O cache de leitura afeta apenas a validação, não os próprios registros de registro.

Lógica de repetição e tratamento de falhas

Se o processador em segundo plano não criar um registro de evento, o sistema tentará novamente automaticamente por até seis horas. Isso se aplica a cenários de falha síncrona e assíncrona, garantindo a confiabilidade dos dados sem a necessidade de intervenção manual.

Limites de taxa de transferência e do Dataverse

O principal fator limitante para cenários de registro sem formulário é a velocidade com que as entidades de registro de tickets podem ser criadas no Dataverse. Em condições normais, o Dataverse impõe um limite de 6.000 solicitações de API, dentro de uma janela deslizante de cinco minutos, por usuário e servidor Web. A plataforma poderá retornar um 429 Too Many Requests erro se esses limites forem excedidos. Saiba mais: Limites da API de proteção de serviço.

Importante

Se o evento usar um gateway de pagamento, etapas de validação adicionais poderão ser aplicadas e a taxa de transferência efetiva poderá ser menor. Os clientes que usam gateways de pagamento devem validar o comportamento de cache para sua configuração específica.