O Eventick foi criado por desenvolvedores. Sabemos da importância de uma API para que aplicativos possam se integrar com a nossa plataforma. Seguimos as orientaçoes de Design RESTful e JSON API.

A API está disponivel somente via HTTPS. A URL base é https://www.eventick.com.br/api/v1. Todos os dados devem ser recebidos e enviados em JSON. Os campos de data e tempo estarão no formato ISO 8601: YYYY-MM-DDTHH:MM:SS±hh:mm

Erros

Utilizamos os status code do protocolo HTTP, disponíveis no header de cada response.

200 OK
Tudo funcionou como esperado
400 Bad Request
Geralmente, um problema com os parâmetros.
401 Unauthorized
Tentativa de acesso com token inválido.
404 Not Found
O recurso acessado não existe.
50X Server errors
Falha nossa, algum erro no servidor.

Bibliotecas

Para agilizar seu desenvolvimento, alguns desenvolvedores criaram bibliotecas para nossa API e plugins. Caso você tenha criado uma e deseja incluir na lista, é só nos avisar.

Requisitando token

Ao executar uma autenticação você receberá um token para as demais requisições. A autenticação é via HTTP Basic Auth.

Autenticação via token é ideal para scripts próprios, mas não é recomendado para software de terceiros.

Resource URL

GET https://www.eventick.com.br/api/v1/tokens.json

Parâmetros

email
Obrigatório.

Você deve informar o email que você utiliza para acessar sua conta no Eventick.

password
Obrigatório.

Senha utlizada para acessa sua conta no Eventick.

Exemplo de Requisição

$ curl https://www.eventick.com.br/api/v1/tokens.json \
    --user 'email@eventick.com.br:password'

Exemplo de Resposta

{
    "token":"dpoi2154wijdsk4fo65ow4o2pkd"
}

Permite acessar as informações dos eventos de um usuário.

Listando eventos

Resource URL

GET https://www.eventick.com.br/api/v1/events.json

Parâmetros

auth_token
Obrigatório.

Token necessário para identificação do usuário.

Exemplo de Requisição

$ curl https://www.eventick.com.br/api/v1/events.json \
    -u 'YUxHFjkB1x3QHB5ak5qr:'

Exemplo de Resposta

{
  "events":[
    {
      "id": 11,
      "start_at": "2012-10-17T16:00:00-03:00",
      "title": "teste",
      "theme_color": "ffb300",
      "thumbnail_url": "https://s3-sa-east-1.amazonaws.com/eventick-events-images/0a7a9a3c-46ef-4fa9-b290-a716f756ebc9/download.crop_275x82_0,51.scale_crop_357x107.jpeg"
    }
  ]
}

Informação de um evento

Resource URL

GET https://www.eventick.com.br/api/v1/events/:id.json

Parâmetros

auth_token
Obrigatório.

Token necessário para identificação do usuário.

id
Obrigatório.

O identificador do evento.

Exemplo de Requisição

$ curl https://www.eventick.com.br/api/v1/events/1706.json \
    -u 'YUxHFjkB1x3QHB5ak5qr:'

Exemplo de Resposta

{
  "events":[
    {
      "id": 11,
      "start_at": "2012-10-17T16:00:00-03:00",
      "title":"Abril pro Ruby'13",
      "venue":"Faculdade Marista",
      "slug":"abrilproruby",
      "theme_color": "ffb300",
      "thumbnail_url": "https://s3-sa-east-1.amazonaws.com/eventick-events-images/0a7a9a3c-46ef-4fa9-b290-a716f756ebc9/download.crop_275x82_0,51.scale_crop_357x107.jpeg",
      "links":{
        "tickets":[
          {
              "id":4464,
              "name":"Segundo lote + camisa",
           },
           {
              "id":4463,
              "name":"Ingresso promocional"
           }
        ]
      }
    }
  ]
}

Permite acessar a lista de participantes de um evento e informar ao Eventick os participantes cujo check-in já foi realizado.

Listagem de Participantes

Resource URL

GET https://www.eventick.com.br/api/v1/events/:event_id/attendees.json

Parâmetros

auth_token
Obrigatório.

Token necessario para identificação do usuário.

event_id
Obrigatório.

O identificador do evento que você deseja listar os participantes.

checked_after
Opcional.

Ao informar esse parametro serão retornados apenas os participantes que fizeram após essa hora.

Exemplo de Requisição

$ curl https://www.eventick.com.br/api/v1/events/1706/attendees.json?checked_after=2012-10-17T16:00:00-03:00 \
    -u 'YUxHFjkB1x3QHB5ak5qr:'

Exemplo de Resposta

{
  "attendees":[
    {
      "id": 29,
      "name": "Davidson",
      "code": "ZVYNDZ",
      "ticket_type": "mas",
      "checked_at": "2012-10-17T16:54:35-03:00",
      "email": "davidson@eventick.com.br"
    },
    {
      "id": 30,
      "name": "Cirdes",
      "code": "T84LCH",
      "ticket_type": "mas",
      "checked_at": "",
      "email": "cirdes@eventick.com.br"
    }
  ]
}

Informação de um participante

Resource URL

GET https://www.eventick.com.br/api/v1/events/:event_id/attendees/:id.json

Parâmetros

auth_token
Obrigatório.

Token necessário para identificação do usuário.

event_id
Obrigatório.

O identificador do evento do participante.

id
Obrigatório.

O identificador do participante.

Exemplo de Requisição

$ curl https://www.eventick.com.br/api/v1/events/1706/attendees/69782.json \
    -u 'f9d93dk211394:'

Exemplo de Resposta

{
  "attendees":[
    {
      "id": 69782,
      "name": "Davidson",
      "code": "ZVYNDZ",
      "ticket_type": "mas",
      "checked_at": "2012-10-17T16:54:35-03:00",
      "email": "davidson@eventick.com.br"
    }
  ]
}

Check-in de um participante

Permite que você marque um participante como checado (check-in realizado).

Resource URL

PUT https://www.eventick.com.br/api/v1/events/:event_id/attendees/:code.json

Parâmetros

auth_token
Obrigatório.

Token necessário para identificação do usuário.

event_id
Obrigatório.

O Identificador do evento do qual você deseja listar os participantes.

code

Código do ingresso do participante.

checked_at

Especifica a hora que o participante foi checado.

Exemplo de Requisição

$ curl -X PUT https://www.eventick.com.br/api/v1/events/1706/attendees/AD1243.json \
    -u "f9d93dk211394:" \
    -d "checked_at=2012-10-17T16:54:35-03:00" 

Check-in de vários participantes

Permite que você marque vários participantes como checados. É preciso adicionar o "Content-Type: application/json" no cabeçalho da requisição.

Resource URL

PUT https://www.eventick.com.br/api/v1/events/:event_id/attendees/check_all.json

Parâmetros

auth_token
Obrigatório.

Token necessário para identificação do usuário.

event_id
Obrigatório.

O Identificador do evento do qual você deseja listar os participantes.

attendees

Os participantes a serem checados devem ser enviados nos formato JSON. Ex: { "id": 10, "checked_at": "2012-10-17T16:54:35-03:00"}

Exemplo de Requisição

$ curl -X PUT https://www.eventick.com.br/api/v1/events/:event_id/attendees/check_all.json \
    -u "f9d93dk211394:" \
    -H "Content-Type: application/json" \
    -d '{"attendees":[{"id":10,"checked_at":"2012-10-17T16:54:35-03:00"}]}'