Nesta página, basta clicar em "Criar novo token". a qualquer momento você poderá gerar um novo token, a geração de novo token irá invalidar o token gerado anteriormente para o evento.
Efetue testes na plataforma antes da implementação do seu sistema. os dados retornados no modo sandbox são fictícios e não pertencem a nenhum evento.
TOKEN |
sandbox-2e15932a-de2fe4bf-b4a8b15b-f9615da6
|
TICKET_CODE |
TK12MTB
|
TICKET_NAME |
João de Souza Andrade
No modo sandbox você deverá utilizar o nome completo para a busca, no modo produção você poderá efetuar a busca por parte do nome. |
Execute ações de credenciamento e controle de acesso com esta API.
Retorna informações detalhadas sobre os participantes do evento, é possível utilizar parâmetros para filtrar os resultados.
TOKEN
required |
(string)
Token de autenticação do evento.
|
status |
string (Filtra os participantes pelo status da transação)
Enum: CONFIRMADO EM ANALISE PENDENTE CANCELADO REEMBOLSADO Para informações detalhadas sobre o status de uma transação consulte o ítem status das transações |
name |
string (filtra participantes pelo seu nome)
este campo deverá ter no mínimo 4 caracteres para efetuar a busca |
email |
string (filtra participantes pelo e-mail relacionado ao ingresso)
|
ticket_code |
string (filtra participantes pelo Qr Code do ingresso)
|
checkin |
boolean (filtra participantes por check-in)
Este filtro só está disponível no modo produção Enum: TRUE FALSE |
field_sort |
string (Permite que os resultados sejam ordenados)
deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por (virgula) |
sort |
string (Ordenação dos resultados)
Default: ASC Enum: ASC DESC |
id |
int32 (Identificador único do participante)
|
||||||||
name |
string (Nome do participante)
|
||||||||
email |
string (E-mail do participante)
|
||||||||
ticket_code |
string (Código Qr code do ingresso)
|
||||||||
ticket_name |
string (Nome do ingresso)
|
||||||||
date |
string (Data do cadastro)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-23 13:10:00) |
||||||||
checkin |
boolean (Se o check-in foi realizado)
|
||||||||
checkin_date |
string (Data do check-in)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-23 13:10:00) |
||||||||
checkin_ref |
string (Campo opcional utilizado no check-in do participante)
|
||||||||
custom_form |
<object> (Formulário personalizado.)
Lista de campos personalizados do formulário de compra do ingresso |
||||||||
custom_form responses
|
|||||||||
event_id |
int32 (Identificador único do evento)
|
||||||||
transaction |
string (Identificador único da transação)
|
||||||||
ticket_price |
float (Preço do ingresso)
|
||||||||
ticket_tax |
float (Taxa de venda do ingresso)
|
||||||||
ticket_amount |
float (Preço de venda do ingresso)
O preço de venda final pode ser diferente devido a parcelamento com juros, o valor final será relacionado na transação do pedido. |
||||||||
ticket_status |
string (Status da transação)
Enum: CONFIRMADO EM ANALISE PENDENTE CANCELADO REEMBOLSADO Para informações detalhadas sobre o status de uma transação consulte o ítem status das transações |
Efetua check-in de um participante utilizando o Qr Code do ingresso. Somente será possível efetuar check-in de participantes com status confirmado.
TOKEN
required |
(string)
Token de autenticação do evento.
|
TICKET_CODE required |
string (Código Qr Code do ingresso)
|
CHECKIN_DATE optional |
string (Data e hora do check-in)
Data no formato YYYY-MM-DD HH:mm:ss (2020-01-08 13:46:42) Defaut: CURRENT TIMESTAMP [BRT] |
CHECKIN_REF optional |
string(20) (Campo opcional para referência do check-in)
Você pode usar este campo para identificar por exemplo, a máquina que efetuou o check-in (Número de IP) |
status |
boolean (Se o check-in foi realizado)
|
date |
string (Data do check-in)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-23 13:10:22) |
message |
string (Mensagem de retorno)
|
status |
TRUE
|
message |
Check-in realizado.
|
status |
FALSE
|
message |
Ingresso não encontrado.
|
message |
O check-in deste ingresso já foi realizado.
|
Retorna a lista de ingressos disponíveis para venda, os ingressos retornados serão aqueles que estão dentro do prazo de venda, não estão esgotados, não estão ocultos e a sua quantidade mínima de venda ser iqual a 1
TOKEN
required |
(string)
Token de autenticação do evento.
|
ticket_id |
int32 (Identificador único do ingresso)
|
name |
string (Nome do ingresso)
|
ticket_price |
float (preço do ingresso)
|
ticket_tax |
float (taxa do ingresso)
|
ticket_amount |
float (Preço de venda do ingresso)
Utilize este valor para efetuar a venda do ingresso |
number_tickets |
int32 (Quantidade de ingressos disponíveis para venda)
|
end_date |
string (Data máxima de venda do ingresso)
Data no formato YYYY-MM-DD HH:mm:ss (2020-11-23 16:10:22) |
Efetua a reserva de ingressos para a venda
TOKEN
required |
(string)
Token de autenticação do evento.
|
TICKET_ID required |
int32 (Identificador único do ingresso que foi recebido no passo anterior)
|
NUMBER_TICKETS required |
int32 (Quantidade de tickets para reserva)
No momento a API evemplus só permite a reserva de um ingresso por vez, portante este valor sempre deverá ser 1 |
status |
boolean (Se reserva foi efetuada)
|
reserve_id |
string (Identificador único da reserva)
este valor será solicitado posteriormente para o cadastro do participante |
time |
string (Tempo em milissegundos até a reserva expirar)
|
Efetua uma nova inscrição no evento, todas as inscrições realizadas na API se comportam como uma inscrição realizada dentro do gestor do evento. (Inscrição manual)
TOKEN
required |
(string)
Token de autenticação do evento.
|
RESERVE_ID required |
string (Código da reserva obtido no passo anterior)
|
NAME required |
string(200) (Nome para geração do ingresso)
|
EMAIL optional |
string(200) (E-mail da conta Evemplus)
Apesar de não ser obrigatório este e-mail será utilizado para efetuar um pre-cadastro na Evemplus (quando não existir esta conta), ou incluirá esse ingresso na conta associada a este e-mail do usuário, permitindo emissão do certificado de participação ou pesquisa de satisfação quando disponibilizado pelo organizador. |
CHECKIN optional |
boolean (Se já efetuar o check-in do participante no ato do cadastro)
Defaut: FALSE Enum: TRUE FALSE |
INFORMAÇÕES DE COBRANÇA |
|
BUYER_NAME optional |
string (Nome do comprador)
Defaut: adicionado manualmente |
BUYER_DOC_NUM optional |
string (Número do documento)
Número do CPF ou CNPJ |
BUYER_PHONE optional |
string (Telefone do comprador)
|
BUYER_ADDRESS optional |
string (Endereço do comprador)
|
ADDRESS_NUM optional |
string (Número)
|
ADDRESS_ALT optional |
string (Complemento)
|
NEIGHBORHOOD optional |
string (Bairro)
|
CITY optional |
string (Cidade)
|
STATE optional |
string (Estado)
|
ZIP_CODE optional |
string (CEP)
|
status |
boolean (Se o cadastro foi realizado)
|
id |
string (identificador único do participante)
|
ticket_code |
string (Código Qr Code do ingresso)
|
Cancela uma reserva e libera o ingresso para a venda novamente.
TOKEN
required |
(string)
Token de autenticação do evento.
|
RESERVE_ID required |
string (Código da reserva)
|
status |
boolean (Se reserva foi cancelada)
|
message |
string (Mensagem de retorno do cancelamento)
|
CONFIRMADO |
Significa que a transação está confirmada, para pagamento gratuito o status retornado também é confirmado.
|
EM ANALISE |
Significa que a transação está pendente de aprovação (cartão de crédito)
|
PENDENTE |
Significa que a transação está pendente de pagamento (boleto bancário e débito bancário)
|
CANCELADO |
Significa que o pedido não foi aprovado ou que o pagamento não foi concluído e, portanto, não foi pago
|
REEMBOLSADO |
Significa que foi solicitado o reembolso da transação.
|
error |
FALSE
|
code |
1
|
message |
Evemplus credential API is working correctly
|