Está é a documentação para o uso da API do Follow Events. Folllow events é uma plataforma de agendamento de eventos voltada ao mercado de Live Stream, facilitando ao usuário encontrar o que deseja e o produtor de conteúdo a destacar seus eventos e criar seus eventos de sorte pra atrair ou recompensar a audiência.
URL base da API: https://follow-events-api.herokuapp.com/
Por meio da rota de usuário será possível fazer as seguintes requisições:
| Método | Descrição |
|---|---|
POST/users |
Criar um novo usuário |
POST/login |
Realizar o login do usuário |
GET/users/<user_id> |
Buscar por um usuário |
PATCH/users/<user_id> |
Editar um usuário |
DELETE/users/<user_id> |
Deletar um usuário |
Criação de um novo usuário
POST/users - Formato da requisição
{
"name": "johndoe",
"username": "John Doe",
"email": "johndoe@email.com",
"password": "1234"
}Formato da resposta
{
"id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"username": "John Doe",
"name": "johndoe",
"email": "johndoe@email.com",
"profile_picture": null,
"creator": false
}Login do usuário
POST/login - Formato da requisição
{
"name": "johndoe",
"password": "1234"
}Formato da resposta
{
"id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"name": "johndoe",
"username": "John Doe",
"email": "johndoe@email.com",
"profile_picture": null,
"creator": true,
"schedule": "https://follow-events-api.herokuapp.com/users/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc/schedule",
"events": "https://follow-events-api.herokuapp.com//events/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"access_token": "access_token"
}Buscar por um usuário
Está rota precisa da autorização do token!
GET/users/<user_id> - Formato da requisição
Não há corpo de requisição.
Formato da resposta
{
"id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"name": "John Doe",
"username": "johndoe",
"email": "johndoe@email.com",
"profile_picture": null,
"creator": true,
"schedule": "https://follow-events-api.herokuapp.com/users/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc/schedule",
"events": "https://follow-events-api.herokuapp.com/events/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc"
}Atualizar os dados de um usuário
Está rota precisa da autorização do token!
PATCH/users/<user_id> - Formato da requisição
{
"creator": true
}Formato da resposta
{
"id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"name": "Joao",
"username": "joao123",
"email": "joao1234@gmail.com",
"profile_picture": null,
"creator": true,
"schedule": "https://follow-events-api.herokuapp.com/users/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc/schedule",
"events": "https://follow-events-api.herokuapp.com/events/f0b72181-00fc-4bc0-ad78-b73e31d9b7fc"
}Deletar um usuário
Está rota precisa da autorização do token!
DELETE/users/<user_id> - Formato da requisição
Não há corpo de requisição.
Formato da resposta
Não há corpo de resposta.
Por meio da rota de eventos será possível fazer as seguintes requisições:
| Método | Descrição |
|---|---|
POST/events |
Criar um novo evento |
GET/events |
Traz uma lista com todos os eventos |
GET/events/<user_id> |
Traz todos os eventos do usuário em especifico |
PATCH/events/<event_id> |
Editar um evento |
DELETE/events/<event_id> |
Deletar um evento |
Criar um novo evento
Está rota precisa da autorização do token!
POST/events - Formato da requisição
Nesta rota terá que passar 2 arquivos multipart:
file : Será um arquivo do tipo imagem ou vídeo, com um máximo de 10mb.
data : Será um json no formato abaixo.
{
"name": "evento",
"description": "descrição do evento",
"event_link": "plataforma",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"categories": ["Games", "Live"]
}Formato da resposta
{
"id": "b9caf35c-02fe-4e84-986a-1ff46c48e562",
"name": "Evento12",
"description": "uma descrição para testar",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/19b8e308-868d-4d02-b4a4-e567544e2b16.png",
"event_link": "twitch",
"created_at": "Sun, 01 May 2022 01:16:05 GMT",
"creator_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"quantity_users": 0,
"categories": ["Games"],
"comments": "https://follow-events-api.herokuapp.com/events/b9caf35c-02fe-4e84-986a-1ff46c48e562/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/b9caf35c-02fe-4e84-986a-1ff46c48e562/giveaway"
}Trazer uma lista com todos os eventos
GET/events - Formato da requisição
Não há corpo de requisição.
Formato da resposta
[
{
"id": "c97820b0-e0d6-45b8-b554-38d3e6dc798d",
"name": "Evento1344444666344",
"description": "uma descrição",
"event_date": "12/12/2023",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/2584339d-1df6-40d0-9457-39f2dff24585.png",
"event_link": "link",
"created_at": "Fri, 29 Apr 2022 02:00:19 GMT",
"creator_id": "60762d5d-0946-4702-a213-b8b070e54350",
"quantity_users": 0,
"categories": ["Games"],
"comments": "https://follow-events-api.herokuapp.com/events/c97820b0-e0d6-45b8-b554-38d3e6dc798d/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/c97820b0-e0d6-45b8-b554-38d3e6dc798d/giveaway"
},
{
"id": "44d41135-36e5-432d-8c05-6ce0d66e7ce1",
"name": "Evento212121",
"description": "Sua descrição",
"event_date": "12/12/2023",
"type_banner": "video",
"link_banner": "https://follow-events.s3.amazonaws.com/51910025-4990-4e75-baf2-f8cb08b57dcf.mp4",
"event_link": "link",
"created_at": "Fri, 29 Apr 2022 22:59:34 GMT",
"creator_id": "60762d5d-0946-4702-a213-b8b070e54350",
"quantity_users": 0,
"categories": ["Live"],
"comments": "https://follow-events-api.herokuapp.com/events/44d41135-36e5-432d-8c05-6ce0d66e7ce1/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/44d41135-36e5-432d-8c05-6ce0d66e7ce1/giveaway"
},
{
"id": "efa50993-b3e5-46ee-a0cf-82864d2502e1",
"name": "Evento212121",
"description": "coloque seu texto aqui",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/c428e2b2-6aba-40dd-bb9d-2f58e79acc80.png",
"event_link": "youtube",
"created_at": "Sat, 30 Apr 2022 01:55:48 GMT",
"creator_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"quantity_users": 0,
"categories": ["Sports"],
"comments": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/giveaway"
}
]Trazer todos eventos de usuário
GET/events/<user_id> - Formato da requisição
Não há corpo de requisição.
Formato da resposta
[
{
"id": "efa50993-b3e5-46ee-a0cf-82864d2502e1",
"name": "Evento 1",
"description": "uma descrição",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/c428e2b2-6aba-40dd-bb9d-2f58e79acc80.png",
"event_link": "youtube",
"created_at": "Sat, 30 Apr 2022 01:55:48 GMT",
"creator_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"quantity_users": 0,
"categories": ["Games"],
"comments": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/giveaway"
},
{
"id": "efa50993-b3e5-46ee-a0cf-82864d2502e1",
"name": "Evento 2",
"description": "descrição do usuário",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/c428e2b2-6aba-40dd-bb9d-2f58e79acc80.png",
"event_link": "youtube",
"created_at": "Sat, 30 Apr 2022 01:55:48 GMT",
"creator_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"quantity_users": 0,
"categories": ["Music"],
"comments": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/efa50993-b3e5-46ee-a0cf-82864d2502e1/giveaway"
}
]Editar um evento
Está rota precisa da autorização do token!
Nesta rota poderá passar 2 arquivos multipart:
file : Será um arquivo do tipo imagem ou vídeo, com um máximo de 10mb.
data : Será um json com as chaves e valores.
Na edição de um usuário pode se atualizar todas as caracteristicas passadas no exemplo abaixo:
PATCH/events/<user_id> - Formato da requisição
{
"name": "Evento 2",
"description": "descrição do usuário",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"event_link": "youtube",
"categories": ["Music"]
}Deletar um evento
Está rota precisa da autorização do token!
DELETE/users/<user_id> - Formato da requisição
Não há corpo de requisição.
Formato da resposta
Não há corpo de resposta.
Por meio da rota de eventos será possível fazer as seguintes requisições:
| Método | Descrição |
|---|---|
POST/events/<event_id>/comments |
Criar comentário em um evento |
GET/events/<event_id>/comments |
Busca os comentários de um evento |
PATCH/comments/<comment_id> |
Atualizar um comentário |
DELETE/comments/<comment_id> |
Deletar um comentário |
Adicionar um comentário ao evento
Está rota precisa da autorização do token!
POST/events/<event_id>/comments - Formato da requisição
{
"comment": "É o melhor evento do ano !!"
}Formato da resposta
{
"comment": "É o melhor evento do ano !!"
}Trazer a lista de comentários de um evento
GET/events/<event_id>/comments - Formato da requisição
Não há corpo de requisição.
Formato da resposta
[
{
"id": "98542e8d-6adb-4993-8e26-a76cdf637dca",
"comment": "É o melhor evento do ano !!",
"created_at": "Sun, 01 May 2022 19:16:49 GMT",
"user_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"username": "joao123",
"profile_picture": null
},
{
"id": "795fd221-3f03-4f40-b954-4e9a5d2ff413",
"comment": "É o melhor evento do ano !!",
"created_at": "Sun, 01 May 2022 19:16:56 GMT",
"user_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"username": "joao123",
"profile_picture": null
},
{
"id": "b395305c-4297-4579-8f89-e8f5199bbb1b",
"comment": "É o melhor evento do ano !!",
"created_at": "Sun, 01 May 2022 19:16:57 GMT",
"user_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"username": "joao123",
"profile_picture": null
}
]Atualizar um comentário de evento
Está rota precisa da autorização do token!
PATCH/comments/<comment_id> - Formato da requisição
{
"comment": "É o melhor evento do ano !!"
}Formato da resposta
{
"id": "98542e8d-6adb-4993-8e26-a76cdf637dca",
"comment": "olá",
"created_at": "Sun, 01 May 2022 19:16:49 GMT",
"user_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc",
"username": "joao123",
"profile_picture": null
}Deletar um comentário de evento
Está rota precisa da autorização do token!
DELETE/comments/<comment_id> - Formato da requisição
Não há corpo de requisição.
Formato da resposta
Não há corpo de reposta.
Por meio da rota do calendário será possível fazer as seguintes requisições:
| Método | Descrição |
|---|---|
POST/users/<user_id>/schedule |
Criar um novo evento no calendário pessoal |
GET/users/<user_id>/schedule |
Lista todos os eventos do calendário pessoal |
DELETE/users/<user_id>/schedule/<event_id> |
Deletar um evento do calendário do calendário pessoal |
Criação de um novo evento no calendário
Está rota precisa da autorização do token!
POST/users/<user_id>/schedule - Formato da requisição
{
"event_id": "f0b72181-00fc-4bc0-ad78-b73e31d9b7fc"
}Formato da resposta
{
"message": "Event added to calendar."
}Buscar eventos no calendário do usuário
Está rota precisa da autorização do token!
GET /users/<user_id>/schedule - Formato da requisição
Não há corpo de requisição.
Formato da resposta
[
{
"id": "179a35d9-2746-4724-a938-d1ed60265b16",
"name": "Live do Stag",
"description": "Final da Copa do Mundo",
"event_date": "Fri, 13 May 2022 15:21:41 GMT",
"type_banner": "image",
"link_banner": "https://follow-events.s3.amazonaws.com/712b4496-2600-4ea9-82ce-087941f6bc71.png",
"event_link": "www.twitch.tv",
"created_at": "Sun, 01 May 2022 19:09:52 GMT",
"creator_id": "b4e9e4f2-ef98-49d9-a864-03ad432c7cee",
"quantity_users": 1,
"categories": ["Futebol"],
"comments": "https://follow-events-api.herokuapp.com/events/179a35d9-2746-4724-a938-d1ed60265b16/comments",
"giveaway": "https://follow-events-api.herokuapp.com/events/179a35d9-2746-4724-a938-d1ed60265b16/giveaway"
}
]Deletar um evento do calendário pessoal
Está rota precisa da autorização do token!
DELETE/users/<user_id>/schedule/<event_id> - Formato da requisição
Não há corpo de requisição.
Não há retorno.
Por meio da rota do calendário será possível fazer as seguintes requisições:
| Método | Descrição |
|---|---|
POST/events/<event_id>/giveaway |
Criar um novo evento de sorte |
GET/events/<event_id>/giveaway |
Listar todos os eventos de sorte |
PATCH/events/<event_id>/giveaway/<giveaway_id> |
Editar um evento de sorte |
DELETE/events/<event_id>/giveaway/<giveaway_id |
Deletar um evento de sorte |
Criação de um novo evento de sorte
Está rota precisa da autorização do token!
POST/events/<event_id>/giveaway - Formato da requisição
{
"name": "Sorteio Hamburgão",
"description": "Melhor X-tudo de Colatina-ES",
"award": "X-tudão",
"award_picture": "https://xtudoreceitas.com/wp-content/uploads/xtudo-480x270.png"
}Formato da resposta
{
"id": "8c2a81ea-e82b-46ba-a69f-71718bbcdcae",
"name": "Sorteio Hamburgão",
"description": "Melhor X-tudo de Colatina-ES",
"award": "X-tudão",
"award_picture": "https://xtudoreceitas.com/wp-content/uploads/xtudo-480x270.png",
"active": true,
"created_at": "Mon, 02 May 2022 18:54:03 GMT",
"event_id": "af38606a-b45c-417d-99e5-5deb8163d698"
}Buscar eventos de sorte
Está rota NÃO precisa da autorização do token!
GET/events/<event_id>/giveaway - Formato da requisição
Não há corpo de requisição.
Formato da resposta
[
{
"id": "8c2a81ea-e82b-46ba-a69f-71718bbcdcae",
"name": "Sorteio Hamburgão",
"description": "Melhor X-tudo de Colatina-ES",
"award": "X-tudão",
"award_picture": "https://xtudoreceitas.com/wp-content/uploads/xtudo-480x270.png",
"active": true,
"created_at": "Mon, 02 May 2022 18:54:03 GMT",
"event_id": "af38606a-b45c-417d-99e5-5deb8163d698"
}
]Atualizar um evento de sorte
Está rota precisa da autorização do token!
PATCH/events/<event_id>/giveaway/<giveaway_id> - Formato da requisição
{
"name": "Sk8 Manaus",
"description": "Sorteio aos inscritos do canal",
"award": "Skate Blacksheep"
}{
"id": "836b5372-f1b4-43d1-b387-7532507c1f74",
"name": "Sk8 Manaus",
"description": "Sorteio aos inscritos do canal",
"award": "Skate Blacksheep",
"award_picture": "https://truck.com/wp-content/uploads/sk8-480x270.png",
"active": true,
"created_at": "Mon, 02 May 2022 19:26:36 GMT",
"event_id": "af38606a-b45c-417d-99e5-5deb8163d698"
}Deletar um evento de sorte
Está rota precisa da autorização do token!
PATCH/events/<event_id>/giveaway/<giveaway_id> - Formato da requisição
Não há corpo de requisição.
{
"message": "Event deleted from calendar."
}Possíveis erros nas requisições 400 BAD REQUEST
Formato da resposta
{
"missing_keys": ["name"]
}Formato da resposta
{
"error": "Email format not acceptable: joao@, try ex.: your_mail@your_provider.com"
}Formato da resposta
{
"error": {
"name": "must be a string"
}
}Formato da resposta
{
"error": "Incoming value is empty."
}Formato da resposta
{
"error": "Name has to be less than 100 characters. If your name is greater than that, try abbreviate it. :D"
}Formato da resposta
{
"error": "Username has to be 6 to 30 characters."
}Formato da resposta
{
"error": "Event must be in the future"
}Formato da resposta
{
"error": "The id 23b15222c13e-23b1-4f31-a021-8455f1cbdae3 is not valid."
}Formato da resposta
{
"error": "This link violates the platform rules"
}Formato da resposta
{
"error": {
"category 5": "must be a valid string",
"category True": "must be a valid string",
"category 4.6": "must be a valid string"
}
}Possíveis erros nas requisições 401 UNAUTHORIZED
Formato da resposta
{
"error": "Missing authorization token"
}Formato da resposta
{
"error": "Unauthorized"
}Formato da resposta
{
"error": "The token has expired"
}Formato da resposta
{
"error": "Invalid token."
}Possíveis erros nas requisições 403 FORBIDDEN
Formato da resposta
{
"error": "Invalid email or password."
}Possíveis erros nas requisições 404 NOT FOUND
Formato da resposta
{
"error": "The id 5222c13e-23b1-4f31-a021-8455f1cbdae3 is not in database."
}Possíveis erros nas requisições 409 CONFLICT
Formato da resposta
{
"error": "Username already exists"
}Formato da resposta
{
"error": "Email already exists"
}Possíveis erros nas requisições 413 REQUEST ENTITY TOO LARGE
Formato da resposta
{
"error": "The suported file is until 10MB"
}Possíveis erros nas requisições 415 UNSUPPORTED MEDIA TYPE
Formato da resposta
{
"error": "Only image and video files are supported"
}Copyright (c) Follow Events, Inc. and its affiliates.