Manual API pública Evemplus versão (1.0.0)
Há 13 semanas Atualizado
Introdução
Gerar token do evento
Informações do evento
Participantes do evento
Check-in realizado
Retornar pedidos
Participantes por transação
Listar tokens dos eventos

Introdução


Seja bem-vindo à API pública da plataforma Evemplus :)

A API da Evemplus é a interface pública que te permite acessar os dados da plataforma Evemplus. Através dela é possível obter várias informações relacionadas aos eventos criados por você, participantes, transações e ingressos. A API fornece endpoints com resultados representados em formato JSON, e em conformidade com o princípio REST de maneira segura, eficiente e de fácil integração. Para garantir a segurança de acesso somente a dados relacionados aos seus eventos, a API exige tambem a autenticação prévia.

Neste documento você encontrará a referência técnica de como acessar todos os serviços disponíveis da API.

Token para autenticação do evento



Para executar requisições válidas à Evemplus API é necessário uma chave de acesso (token) associada ao seu evento na plataforma. Este token deverá assinar todas as requisições enviadas à API.

Cada evento possui um token único, a API retornará informações apenas do evento relacionado ao seu token. para ter acesso a lista de eventos e seus respectivos tokens criados acesse o ítem "Listar tokens dos eventos utilizando a API"

Para criar um novo token, acesse dentro do gerenciador do seu evento, no menu lateral (versão desktop) a opção "pacotes" e procure pelo pacote "Evemplus API pública", (na versão de celular clique no menu do topo e clique em pacotes), clique em "gerenciar pacote" ou "Instalar pacote" (caso o pacote não esteja instalado), pronto, você terá acesso a página de criação ou modificação de token.



Nesta página, basta clicar em "Criar novo token". Caso seu token já tenha sido gerado ele será omitido por questão de segurança, você poderá encaminha-lo para o e-mail de sua conta ou gerar um novo token, a geração de novo token irá invalidar o token gerado anteriormente para o evento.

Informações do evento

POST /public/v1/event

Retorna informações detalhadas sobre o evento.

HEADER PARAMETERS
TOKEN
required
(string)
Token de autenticação do evento.
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/event' \
--header 'token: <CODIGO_TOKEN>'

Responses application/json

id
int32 (Identificador único do evento)
name
string (Nome do evento)
start_date
string (Data de início do evento)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-23 13:10:00)
end_date
string (Data de término do evento)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-24 22:40:00)
category
string (Categoria do evento)
image
string (Url da imagem do evento, utilizada como banner ou logo do evento)
url
string (Url do evento)
address_name
string (Título da localização do evento, caso o evento seja on-line exibe a Url de transmissão)
address
string (endereço do evento, exibe NULL em caso de evento on-line)
address_num
string (Número do local, exibe NULL em caso de evento on-line)
address_alt
string (Complemento, exibe NULL em caso de evento on-line)
neighborhood
string (Bairro, exibe NULL em caso de evento on-line)
city
string (Cidade, exibe NULL em caso de evento on-line)
state
string (Estado, exibe NULL em caso de evento on-line)
zip_code
string (CEP, exibe NULL em caso de evento on-line)
detail
string (Descrição do evento)
Todo HTML utilizado na formatação será retornado.
public_event
boolean (Se o evento está como público)
published
boolean (Se o evento está publicado)
Eventos publicados estarão com o valor TRUE enquanto eventos não publicados estarão com o valor FALSE.
event_creation
string (Data de criação do evento)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-23 13:10:00)

+ Error responses (400)

Listar participantes do evento

POST /public/v1/participants

Retorna informações detalhadas sobre os participantes do evento, é possível utilizar parâmetros para filtrar os resultados.

HEADER PARAMETERS
TOKEN
required
(string)
Token de autenticação do evento.
POST PARAMETERS
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
ticket_code
string (filtra participantes pelo Qr Code do ingresso)
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
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/participants' \
--header 'token: <CODIGO_TOKEN>'

Responses application/json

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)
custom_form
<object> (Formulário personalizado.)
Lista de campos personalizados do formulário de compra do ingresso
custom_form responses
id
int32 (Identificador único do campo personalizado)
type
string (Tipo de campo personalizado)
Enum: address cpf cpnj rg date text textarea option radio checkbox termo
name
string (Nome do campo personalizado)
value
string (Valor do campo personalizado)
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

+ Error responses (400)

Participantes com check-in realizado

POST /public/v1/checkin

Retorna todos os participantes que efetuaram check-in no evento.

HEADER PARAMETERS
TOKEN
required
(string)
Token de autenticação do evento.
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/checkin' \
--header 'token: <CODIGO_TOKEN>'

Responses application/json

id
int32 (Identificador único do participante)
name
string (Nome do participante)
ticket_code
string (Código Qr code do ingresso)
ticket_name
string (Nome do ingresso)
checkin
boolean (se check-in foi realizado)
date
string (Data do check-in)
Data no formato YYYY-MM-DD HH:mm:ss (2019-11-24 22:40:00)

+ Error responses (400)

Listar pedidos do evento

POST /public/v1/payments

Retorna todos os pedidos do evento.

HEADER PARAMETERS
TOKEN
required
(string)
Token de autenticação do evento.
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/payments' \
--header 'token: <CODIGO_TOKEN>'

Responses application/json

id
int32 (Identificador único do pedido)
transaction
string (Identificador único da transação)
tickets
int32 (Quantidade de ingressos da transação)
receiver_name
string (Nome para recebimento do(s) ingresso(s))
receiver_email
string (E-mail para recebimento do(s) ingresso(s))
buyer_name
string (Nome do comprador)
buyer_doc_type
string (Tipo de documento do comprador)
Enum: CPF CNPJ
buyer_doc_num
string (Número do documento)
buyer_phone
string (Telefone do comprador)
address
string (Endereço do comprador)
address_num
string (Número)
address_alt
string (Complemento)
neighborhood
string (Bairro)
city
string (Cidade)
state
string (Estado)
zip_code
string (CEP)
discount_code
string (Código promocional utilizado)
rep_tax
boolean (Se a taxa foi repassada para o participante)
tax
float (Valor da taxa)
amount
float (Valor total da transação)
este valor pode incluir juros de parcelamento no cartão de crédito.
transfer_amount
float (Valor de repasse da transação)
transaction_type
string (Tipo de pagamento)
Enum: CARTÃO DE CRÉDITO BOLETO BANCÁRIO DÉBITO ON-LINE GRATUITO
transaction_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
url
string (Url da transação)
place
string (Local de compra)
Enum: ONLINE PDV MANUAL

+ Error responses (400)

Listar participantes por transação

POST /public/v1/transaction

Retorna as informações dos participantes de uma transação.

HEADER PARAMETERS
TOKEN
required
(string)
Token de autenticação do evento.
POST PARAMETERS
transaction
required
string (Identificador único da transação)
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/transaction' \
--header 'token: <CODIGO_TOKEN>'

Responses application/json

participants
array (Retorna array com as informações dos participantes do evento)
transaction
string (Identificador único da transação)
tickets
int32 (Quantidade de ingressos da transação)
receiver_name
string (Nome para recebimento do(s) ingresso(s))
receiver_email
string (E-mail para recebimento do(s) ingresso(s))
buyer_name
string (Nome do comprador)
buyer_doc_type
string (Tipo de documento do comprador)
Enum: CPF CNPJ
buyer_doc_num
string (Número do documento)
buyer_phone
string (Telefone do comprador)
address
string (Endereço do comprador)
address_num
string (Número)
address_alt
string (Complemento)
neighborhood
string (Bairro)
city
string (Cidade)
state
string (Estado)
zip_code
string (CEP)
phone
string (Telefone do comprador)
discount_code
string (Código promocional utilizado)
rep_tax
boolean (Se a taxa foi repassada para o participante)
tax
float (Valor da taxa)
amount
float (Valor total da transação)
este valor pode incluir juros de parcelamento no cartão de crédito.
transfer_amount
float (Valor de repasse da transação)
transaction_type
string (Tipo de pagamento)
Enum: CARTÃO DE CRÉDITO BOLETO BANCÁRIO DÉBITO ON-LINE GRATUITO
transaction_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
url
string (Url da transação)
place
string (Local de compra)
Enum: ONLINE PDV MANUAL

+ Error responses (400)

Referência status de uma transação

CONFIRMADO
Significa que a transação está confirmada, para pagamento gratuito o status retornado tambem é 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.



Listar tokens dos eventos utilizando a API


Para executar requisições válidas à Evemplus API é necessário um token para autenticação do evento, este token permite o acesso somente das informações do evento a ele relacionada, isso aumenta a segurança e facilita para que você restrinja acesso a determinados eventos. Porém, se você possui muitos eventos na plataforma, o gerenciamento de um token por evento pode se tornar desastrosa.

Para facilitar o gerenciamento dos tokens dos eventos você cria uma chave de acesso e informa quais eventos podem ser listados por aquela chave.

Por exemplo, Imagine que você possua os eventos A, B, C e D em nossa plataforma, e com a chave de acesso XXXX você pode acessar os eventos B e C, mas não permite o acesso aos eventos A e D, simples, isso facilita o gerenciamento de eventos e torna mais segura suas informações.

Utilizando a chave de acesso você envia uma solicitação e recebe todos os tokens dos eventos, a partir dai você terá acesso a todos os eventos dos tokens recebidos.

Veja o diagrama abaixo:



Criar nova chave de acesso


Para criar uma nova chave de acesso, acesse dentro de sua conta Evemplus a opção minha conta, no gerenciamento de sua conta aparecerá a opção de "gerenciamento de chave de acesso". Esta opção só aparecerá se você possuir mais de um evento cadastrado na plataforma Evemplus.

Recebendo tokens

POST /public/v1/tokens

Retorna tokens dos eventos relacionados a chave de acesso.

HEADER PARAMETERS
USER_KEY
required
(string)
Chave de acesso do usuário na plataforma Evemplus.
// Request samples CURL
curl --request POST \
--url 'https://api.evemplus.com.br/public/v1/tokens' \
--header 'user_key: <CHAVE_DE_ACESSO>'

Responses application/json

id
int32 (Identificador único do evento)
name
string (Nome do evento)
token
string (Token de acesso do evento)

+ Error responses (400)

Consultar status de funcionamento da API pública

Você poderá consultar se a API pública Evemplus está funcionando corretamente, enviando uma solicitação para:
POST https://api.evemplus.com.br/public/v1/
RESPONSE SCHEMA: application/json
error
FALSE
code
1
message
Evemplus public API is working correctly










Desenvolvido por Redes sociais Para Compradores Central de ajuda e suporte Visualizar mais eventos Cancelando compra Meus ingressos Desenvolvido por Redes sociais Para Organizadores Central de ajuda e suporte Publicando um evento Nossos preços Evemplus API
EVEMPLUS SOLUÇÕES EM TECNOLOGIA LTDA
Evemplus Brasil - © Copyright 2020
Av. do Contorno, 2905 | Santa Efigênia - Belo Horizonte, MG