Inicio - Even3

Referência da API

Even3 API V1 (deprecated)

Referência técnica dos serviços da API V1: autenticação, evento, participantes, credenciamento, pagamentos, certificados, programação, submissões, página do evento e empresas.

A API V1 não recebe novas funcionalidades. Esta documentação atende quem já possui integração em produção. Para novos projetos, comece pela API V2.

Introdução

A API pública da Even3 permite obter informações relacionadas aos eventos criados por você, como os dados do evento e as informações das pessoas cadastradas.

As respostas são devolvidas em JSON, seguindo o princípio REST. Para garantir que cada integração acesse apenas os dados dos seus próprios eventos, todas as requisições exigem autenticação prévia por token, enviado no header "Authorization-Token".

Cada evento possui a sua própria chave. Isso significa que uma integração que precisa ler dados de vários eventos precisa guardar um token por evento, com exceção das contas do plano empresarial, que possuem um endpoint específico para listar os eventos e seus tokens.

URL base	https://www.even3.com.br/api/v1/
Formato	JSON, seguindo o princípio REST
Autenticação	Header "Authorization-Token", com a chave do evento
Escopo do token	Um token por evento
Status da versão	Em manutenção. Não recebe novas funcionalidades.

Autenticação

Toda requisição precisa enviar a chave de acesso do evento no header "Authorization-Token". Requisições sem o header, ou com um token que não pertence ao evento consultado, não retornam dados.

GET https://www.even3.com.br/api/v1/event
Authorization-Token: SUA_CHAVE_DE_ACESSO

Onde encontrar a chave

A chave fica nas configurações do próprio evento:

Faça login na plataforma Even3 e abra o evento que será integrado.
Vá até o menu "Ferramentas" dentro da sessão "Geral".
Abra a área Integrações. Encontre a integração "API Even3" e gere sua chave. O valor retornado será usado no header das requisições.

Se o mesmo organizador administra vários eventos, repita o processo em cada um: a chave de um evento não dá acesso aos dados de outro.

Importante: a chave dá acesso aos dados do evento. Guarde-a no servidor da sua aplicação e nunca a exponha em código de front-end ou em repositórios públicos.

Serviços disponíveis

Todos os endpoints abaixo são relativos à URL base https://www.even3.com.br/api/v1/, exigem o header "Authorization-Token" e respondem em JSON.

Método	Endpoint	Descrição
GET	/event	Dados do evento, local, datas e entradas
GET	/attendees/	Lista todos os participantes do evento
GET	/attendees/:id	Retorna um participante específico
POST	/attendees/create	Cadastra um participante no evento
POST	/checkin/attendees	Credencia participantes no evento
POST	/checkin/sessions	Credencia participantes em atividades
GET	/payments	Lista os pagamentos do evento
GET	/payments/details	Detalha um pagamento pela referência
GET	/certificates	Participantes com certificado emitido
GET	/session/:id	Atividades do evento, com palestrantes e horários
GET	/speaker/:id	Palestrantes do evento
GET	/session/getschedule	Programação agrupada por dia
GET	/submission/	Modalidades e áreas temáticas
GET	/submission/list	Trabalhos submetidos, autores e apresentação
GET	/hotsite/	Áreas e conteúdos da página do evento
GET	/customclient/events	Eventos e tokens do plano empresarial

Evento

Retorna os dados cadastrais do evento: título, URL, período de realização, período de inscrição, localização e a lista de entradas com seus respectivos preços e vagas.

Retornar dados do evento

GEThttps://www.even3.com.br/api/v1/event

Retorna sempre um único evento — aquele ao qual o token pertence. Os campos "id_ticket_price" retornados dentro de "tickets.prices" são usados para inscrever um participante em uma entrada específica no endpoint de cadastro de pessoas.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_event": 1,
"title": "XV Congresso de Ciência do Desporto e Educação Física dos Países de Língua Portuguesa",
"url": "cdef2014",
"start_date": "2014-04-13T00:00:00",
"end_date": "2014-06-03T00:00:00",
"start_date_registration": "28/11/2013",
"end_date_registration": "31/03/2014",
"summary": "O XV Congresso de Educação Física e Ciência do Desporto dos Países de Língua Portuguesa é um evento internacional de âmbito científico e acadêmico.",
"description": null,
"url_image": "https://images.even3.com.br/P8AIZhrnXjYyZbzpMl_YguQPDnM=/fit-in/250x250/smart/https://even3.blob.core.windows.net/idvisual/cdef.png",
"credit_hour": 0,
"country": "Brasil",
"state": "Pernambuco",
"city": "Recife",
"venue": "Mar Hotel",
"latitude": "-8.0475622",
"longitude": "-34.8769643",
"banner": null,
"tickets": [
{
"title": "Profissional",
"registration_quantity": 4,
"prices": [
{
"id_ticket": 2,
"id_ticket_price": 2,
"price": 370,
"start_date": "2014-01-09T00:00:00",
"due_date": "2014-01-10T00:00:00",
"registration_quantity_price": 1
}
]
}
]
}
],
"count": 1
}

404 Not FoundResposta de erro

{
"message": "string",
"erros": [
{
"code": 0,
"description": "string"
}
],
"count_erros": 1
}

Pessoas

Consulta os participantes inscritos no evento, em lista ou individualmente, e cadastra novas inscrições. Os três endpoints usam o mesmo token do evento.

Retornar participantes

GEThttps://www.even3.com.br/api/v1/attendees/

Retorna todos os participantes do evento. O campo "checkin_code" é o número de inscrição usado no credenciamento, e só aparece para quem já possui inscrição gerada.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_attendees": 9,
"id_event": 1,
"checkin_code": 11,
"name": "Renan José Guedes",
"bagde_name": "Renan Guedes",
"email": "renang@hotmail.com",
"gender": "M",
"photo": "https://graph.facebook.com/1569985586409400/picture?width=150&height=150",
"document": "000.000.000-00",
"confirmed": false,
"registration_category": "",
"registration_date": "",
"registration_hour": ""
}
],
"count": 3
}

Retornar um participante

GEThttps://www.even3.com.br/api/v1/attendees/:id

Retorna um único participante do evento. Quando o id não existe no evento, a resposta é "404" com a lista vazia.

Path parameters

Name	Type	Description
id	string	ID do participante

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKParticipante encontrado

{
"data": [
{
"id_attendees": 9,
"id_event": 1,
"checkin_code": 11,
"name": "Renan José Guedes",
"bagde_name": "Renan Guedes",
"email": "renang@hotmail.com",
"gender": "M",
"photo": "https://graph.facebook.com/1569985586409400/picture?width=150&height=150",
"document": "000.000.000-00",
"confirmed": false,
"registration_category": "",
"registration_date": "",
"registration_hour": ""
}
],
"count": 1
}

404 Not FoundParticipante não encontrado

{
"data": [],
"count": 0
}

Inserir um participante

POSThttps://www.even3.com.br/api/v1/attendees/create

Cadastra um participante no evento e, opcionalmente, o inscreve em uma entrada. O corpo da requisição segue o model Attendee.

O campo "registration.id_ticket_price" define a entrada na qual o participante será inscrito, e o id correspondente vem do endpoint Evento. Com "registration_confirmed" em "true", a inscrição já entra confirmada.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

Request body

{
"name": "string",
"bagde_name": "string",
"email": "string",
"gender": "string",
"photo": "string",
"registration_confirmed": true,
"registration": {
"id_ticket_price": 0,
"price": 0
}
}

200 OKCadastro realizado

"Data entered successfully."

Credenciamento

Registra a presença dos participantes no evento e em atividades específicas. Os dois endpoints recebem uma lista, então é possível enviar vários credenciamentos em uma única requisição, se mostra útil para sincronizar um sistema de portaria em lote.

Credenciar participantes no evento

POSThttps://www.even3.com.br/api/v1/checkin/attendees

Recebe no campo "attendees" uma lista de CheckinAttendee. Cada item identifica o participante pelo "checkin_code" e informa a data do credenciamento.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

Request body

Name	Type	Description
attendees *	array	Lista de "CheckinAttendee"

200 OKCredenciamento registrado

"OK"

Credenciar participantes em atividades

POSThttps://www.even3.com.br/api/v1/checkin/sessions

Recebe no campo "sessions" uma lista de CheckinSession. Aqui o participante é identificado por "id_attendees" e a atividade por "id_session", ambos obtidos nos endpoints de Pessoas e Programação.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

Request body

Name	Type	Description
sessions *	array	Lista de "CheckinSession"

200 OKCredenciamento registrado

"OK"

Pagamentos

Consulta os pagamentos registrados no evento, com valores, status, forma de pagamento e dados do comprador. Também é possível abrir o detalhamento de um pagamento pela referência.

Retornar pagamentos do evento

GEThttps://www.even3.com.br/api/v1/payments

Retorna todas as informações dos pagamentos do evento.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_event": 123456,
"id_payment": 00001,
"reference_payment": "0101010101",
"buyer": "Empresa Geral",
"email_buyer": "empresageral@teste.com.br",
"country_buyer": "Brazil",
"document_buyer": "00000000000",
"description_payment": "1 ingresso(s);",
"date_payment": "28/11/2023",
"hour_payment": "17:21",
"type_payment": "Mastercard",
"method_payment": "Cartão de Crédito",
"amount_payment": 10.00,
"amount_receive_payment": 7.50,
"status_payment": "Pago",
"cupom_payment": "",
"note_payment": " "
}
],
"count": 1
}

404 Not FoundResposta de erro

{
"message": "string",
"erros": [
{
"code": 0,
"description": "string"
}
],
"count_erros": 1
}

Retornar detalhes de um pagamento

GEThttps://www.even3.com.br/api/v1/payments/details

Retorna todas as informações de um pagamento do evento, incluindo o participante e o item adquirido, a partir da referência do pagamento.

Request body

Name	Type	Description
reference *	string	Referência do pagamento. Exemplo: 12345678

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_event": 123456,
"id_payment": 00001,
"reference_payment": "0101010101",
"attendee": "Maria Silva",
"email_attendee": "mariasilva@teste.com.br",
"document_attendee": "",
"phone_attende": "11111111111",
"description": "Ingresso",
"item": "Estudantes",
"amount": 10.00
}
],
"count": 1
}

404 Not FoundResposta de erro

{
"message": "string",
"erros": [
{
"code": 0,
"description": "string"
}
],
"count_erros": 1
}

Certificados

Lista os participantes que já possuem certificado emitido, com o link direto do documento.

Retornar certificados do evento

GEThttps://www.even3.com.br/api/v1/certificates

Retorna todos os participantes do evento que possuem certificados emitidos.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação encontrado nas configurações do evento

200 OKResposta de sucesso

{
"certificates": {
"data": [
{
"id_pessoa": 1234,
"id_event": 123456,
"name": "João Fictício",
"email": "joao@exemplo.com",
"document": "000.000.000-00",
"certificate_url": "https://www.even3.com.br/documentos/imprimir?i=20501620.06783562.5.8.05016200678356258&cc=512BD0AF-4907-4F2F-9D1B-ACA5D75281B0"
}
],
"count": 1
},
"count": 1
}

Programação

Consulta as atividades do evento, os palestrantes vinculados a elas e a grade completa organizada por dia.

Retornar as atividades

GEThttps://www.even3.com.br/api/v1/session/:id

Retorna a lista de atividades do evento ou uma única atividade, quando informado o parâmetro "id".

Path parameters

Name	Type	Description
id	string	ID de uma atividade específica (opcional). Sem o parâmetro, retorna todas as atividades.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_session": 155553,
"id_event": 37524,
"title": "Accessibility Management In Large Companies",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"credit_hour": "1",
"capacity": 50,
"ticket_price": 10.0000,
"type": "Conferência",
"venue": "AUDITORIUM 1",
"tags": "Accessibility, Enterprise",
"speakers": [
{
"id_event": 37524,
"id_speaker": 117452,
"id_session": 155553,
"name": "Katherine Martin",
"photo": "https://images.even3.com.br/4Ru_0labb33RLwLB8BABoTSc38k=/150x150/smart/even3.blob.core.windows.net/geral/1.f8ee65f357fe420ead67.jpeg",
"resume": "Sed convallis quam vel mi porta rutrum.",
"facebook": "",
"linkedin": "https://www.google.com.br/",
"email": "",
"lattes": "https://www.google.com.br/",
"twitter": "",
"site": ""
}
],
"times": [
{
"id_event": 37524,
"id_session": 155553,
"id_time": 534771,
"date": "2020-01-01T00:00:00",
"start_time": "10:00",
"end_time": "11:00"
}
]
}
]
}

404 Not FoundResposta de erro

{
"message": "Something bad happened :(",
"erros": [
{
"code": 204,
"description": "Internal server error"
}
],
"count_erros": 1
}

Retornar palestrantes

GEThttps://www.even3.com.br/api/v1/speaker/:id

Retorna a lista de palestrantes do evento ou um palestrante específico, quando informado o parâmetro "id".

Path parameters

Name	Type	Description
id	string	ID de um palestrante específico (opcional)

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_event": 37524,
"id_speaker": 117452,
"name": "Katherine Martin",
"photo": "https://images.even3.com.br/4Ru_0labb33RLwLB8BABoTSc38k=/150x150/smart/even3.blob.core.windows.net/geral/1.f8ee65f357fe420ead67.jpeg",
"resume": "Sed convallis quam vel mi porta rutrum.",
"facebook": "",
"linkedin": "https://www.google.com.br/",
"email": "",
"lattes": "https://www.google.com.br/",
"twitter": "",
"site": ""
}
]
}

Retornar a programação por dia

GEThttps://www.even3.com.br/api/v1/session/getschedule

Retorna a programação já agrupada por data, para facilitar a montagem de uma grade de programação. Atividades que se repetem em mais de um dia aparecem em cada data e trazem todas as ocorrências no campo "all_dates".

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"data": [
{
"id_schedule": "01012020",
"date": "2020-01-01T00:00:00.0000000",
"day": "quarta-feira",
"sessions": [
{
"id_session": 155553,
"title": "Accessibility Management In Large Companies",
"title_schedule": "Atividades",
"venue": "AUDITORIUM 1",
"description": "Lorem ipsum dolor sit amet.",
"tags": "Accessibility, Enterprise",
"date": "01/01/2020",
"date_UTC": "2020-01-01T00:00:00.0000000",
"start_time": "10:00",
"end_time": "11:00",
"speakers": [
{
"id_speaker": 117452,
"name": "Katherine Martin",
"photo": "https://images.even3.com.br/4Ru_0labb33RLwLB8BABoTSc38k=/150x150/smart/even3.blob.core.windows.net/geral/1.f8ee65f357fe420ead67.jpeg",
"resume": "Sed convallis quam vel mi porta rutrum.",
"facebook": "",
"linkedin": "https://www.google.com.br/",
"email": "",
"lattes": "https://www.google.com.br/",
"twitter": "",
"site": ""
}
],
"all_dates": [
{
"date": "2020-01-01T00:00:00",
"day": "quarta-feira",
"start_time": "10:00",
"end_time": "11:00"
}
]
}
]
}
],
"count": 1
}

Submissões

Consulta as modalidades e áreas temáticas configuradas no evento e o detalhamento dos trabalhos submetidos, incluindo autores e apresentação.

Retornar modalidades e áreas temáticas

GEThttps://www.even3.com.br/api/v1/submission/

Retorna as modalidades e áreas temáticas de submissão do evento.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"submission_type": {
"data": [
{
"id_event": 37524,
"id_submissiontype": 29631,
"url_roles": "https://even3.blob.core.windows.net/geral/Template-para-Trabalhos-completos.docx",
"title": "Regras de submissão de Article"
}
],
"count": 1
},
"topic_area": {
"data": [
{
"id_event": 37524,
"id_topicarea": 30747,
"title": "Tecnologías y Servicios de Acceso a la Información y la Comunicación"
}
],
"count": 1
},
"count": 2
}

404 Not FoundResposta de erro

{
"Message": "No HTTP resource was found that matches the request URI."
}

Retornar detalhes das submissões e apresentações

GEThttps://www.even3.com.br/api/v1/submission/list

Retorna os detalhes das submissões e apresentações de trabalho do evento, incluindo autores e horário de apresentação, quando definido.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"submission": {
"data": [
{
"id_event": 1234,
"id_submission": 567,
"title": "Teste Submissão",
"status": "Aprovado",
"id_submission_type": 123,
"submission_type": "Resumo",
"topic_area": "Exemplo de Área Temática",
"id_topic_area": 456,
"abstract": "https://static.even3.com/processos/322312bac4a4ad081e2.pdf",
"proceedings_abstract": "https://static.even3.com/anais/02340.pdf",
"proceedings_full_paper": "https://static.even3.com/processos/02340.pdf",
"date": "2026-05-16T10:00:00",
"start_time": "10:02",
"end_time": "10:04",
"location": null,
"author": [
{
"id_event": 1234,
"id_submission": 567,
"name": "João Pedro",
"email": "joao@gmail.com",
"is_presenter": false,
"author_order": 1
}
]
}
],
"count": 1
},
"count": 1
}

Página do evento

Retorna as áreas cadastradas no hotsite do evento, na ordem em que aparecem na página, com o conteúdo de cada uma.

Retornar a lista de áreas cadastradas

GEThttps://www.even3.com.br/api/v1/hotsite/

Retorna as áreas cadastradas na página do evento, incluindo o campo "jsonObj", usado por áreas com conteúdo estruturado, como patrocinadores.

Headers

Name	Type	Description
Authorization-Token *	string	Token de autenticação obtido nas configurações do evento

200 OKResposta de sucesso

{
"capa": null,
"areasSite": [
{
"idAreaSite": null,
"titulo": "Sobre o evento",
"subtitulo": "",
"ordem": 1,
"jsonObj": [],
"template": "<p>Texto livre da área</p>"
},
{
"idAreaSite": 9,
"titulo": "Patrocinadores",
"subtitulo": "",
"ordem": 7,
"jsonObj": [
{
"titulo": "teste",
"urlImagem": "https://even3.blob.core.windows.net/pagina-evento/2.94f0dfae23fb4a0ca11d.PNG",
"link": "globo.com.br",
"id": 1
}
],
"template": ""
}
]
}

Empresas

Disponível apenas para contas do plano empresarial. Retorna todos os eventos da conta, com o token de cada um, permitindo consultar vários eventos a partir de uma única integração.

Retornar a lista de eventos da empresa

GEThttps://www.even3.com.br/api/v1/customclient/events

Retorna a lista de eventos do plano empresarial, com o respectivo token de cada evento. É necessário solicitar as credenciais de autenticação ao suporte da Even3.

Headers

Name	Type	Description
Authorization-Token *	string	Solicitar ao suporte
Authorization-App *	string	Solicitar ao suporte

200 OKResposta de sucesso

{
"data": [
{
"id": 1,
"titulo": "Evento teste 1",
"url": "urleventoTeste",
"token": "123456789",
"email_organizador": "apiempresas@even3.com",
"start_date": "2024-01-01",
"start_time": "19:00",
"end_date": "2024-02-01",
"end_time": "21:30",
"local": "Centro de Convenções de Pernambuco",
"city": "Recife",
"state": "Pernambuco",
"country": "Brasil",
"publicated": true,
"privacy": {
"id": 2,
"type": "Privado - com link de acessso"
}
}
]
}

Models

Estruturas de dados usadas no corpo das requisições.

Attendee

Usado em "POST /attendees/create"

Propriedade	Tipo	Descrição
name	string	Nome completo do participante
bagde_name	string	Nome exibido no crachá
email	string	E-mail do participante
gender	string	Gênero do participante
photo	string	URL da foto do participante
registration_confirmed	bool	Indica se a inscrição já entra confirmada
registration.id_ticket_price	int	Entrada na qual o participante será inscrito (ver Evento)
registration.price	decimal	Valor da inscrição

{
"name": "string",
"bagde_name": "string",
"email": "string",
"gender": "string",
"photo": "string",
"registration_confirmed": true,
"registration": {
"id_ticket_price": 0,
"price": 0
}
}

CheckinAttendee

Usado em "POST /checkin/attendees"

Propriedade	Tipo	Descrição
checkin_code	string	Número de inscrição do participante no evento
checkin	int	Flag para credenciar ou não credenciar o participante
checkin_date	datetime	Data de credenciamento

CheckinSession

Usado em "POST /checkin/sessions"

Propriedade	Tipo	Descrição
id_attendees	int	Id do participante
id_session	int	Id da atividade
checkin	int	Flag para credenciar ou não credenciar o participante na atividade
checkin_date	datetime	Data de credenciamento