Notícias

Busca a(s) notícias de uma loja.

Notícias

GET https://api.lojasquare.net/v1/noticias

Lista todas as notícias de uma loja.

Query Parameters

Name	Type	Description
pagina	number	Página para listagem de notícias.

Headers

Name	Type	Description
AUTHORIZATION	string	Token público (KEY-API) de autorização para acesso à informações e identificação de uma loja.

200 Retorno obtido ao encontrar notícias para serem listadas.

[
  {
    "noticiaID": 829,
    "userID": 1,
    "servidor": "TrowCraft",
    "postadoPor": "Trow_Games",
    "detalhes": {
      "titulo": "Loja Square 2.0",
      "subtitulo": "As atualizações que todos esperavam!",
      "img": "https://i.imgur.com/owgQFU7.png",
      "noticia": "...",
      "urlExterna": null,
      "podeComentar": 1,
      "tag": {
        "tagNoticia": "[NOVIDADES]",
        "tagCor": "darkblue"
      },
      "comentarios": [
        {
          "comentador": "Trow_Games",
          "comentario": "Muito feliz pela atualização!",
          "idComentario": 1,
          "timestamp": 1593452480
        }
      ]
    },
    "postadoEm": "1593450069"
  }
]

404 Caso a loja não tenha criado nenhuma notícia ainda.

{
    "msg": "noticia_nao_encontrada"
}

Total Notícias

GET https://api.lojasquare.net/v1/noticias/total

O número total de notícias que foram publicadas para a loja.

Headers

Name	Type	Description
AUTHORIZATION	string	Token público (KEY-API) de autorização para acesso à informações e identificação de uma loja.

200 Retorna o número total de notícias registradas.

{
  "totalNoticias": 17
}

Notícia

GET https://api.lojasquare.net/v1/noticias/:ID

Retorna os detalhes de uma notícia específica. Substitua " :ID " pelo ID da notícia.

Path Parameters

Name	Type	Description
ID	number	ID da notícia que deseja buscar os detalhes.

Headers

Name	Type	Description
AUTHORIZATION	string	Token público (KEY-API) de autorização para acesso à informações e identificação de uma loja.

200 Caso encontre a notícia informada no ID com sucesso!

{
  "noticiaID": 829,
  "userID": 1,
  "servidor": "TrowCraft",
  "postadoPor": "Trow_Games",
  "detalhes": {
    "titulo": "Loja Square 2.0",
    "subtitulo": "As atualizações que todos esperavam!",
    "img": "https://i.imgur.com/owgQFU7.png",
    "noticia": "...",
    "urlExterna": null,
    "podeComentar": 1,
    "tag": {
      "tagNoticia": "[NOVIDADES]",
      "tagCor": "darkblue"
    },
    "comentarios": [
      {
        "comentador": "Trow_Games",
        "comentario": "Muito feliz pela atualização!",
        "idComentario": 1,
        "timestamp": 1593452480
      }
    ]
  },
  "postadoEm": "1593450069"
}

404 Caso a notícia do id informado não seja encontrada, o retorno será o indicado abaixo:

{
    "msg": "noticia_nao_encontrada"
}

Comentários

PUT https://api.lojasquare.net/v1/noticias/:ID/comentarios

Insere um novo comentário na notícia. Substitua " ID " pelo ID da notícia.

Path Parameters

Name	Type	Description
ID	number	ID da notícia que receberá o comentário.

Request Body

Name	Type	Description
comentario	string	Comentário a ser adicionado à notícia.
comentador	string	Nome de quem realizou o comentário.

200 Retorna todas as informações da notícia, com o último comentário inserido.

{
  "noticiaID": 829,
  "userID": 1,
  "servidor": "TrowCraft",
  "postadoPor": "Trow_Games",
  "detalhes": {
    "titulo": "Título Teste #2",
    "subtitulo": "Sub-título Teste #2",
    "img": "https://i.imgur.com/owgQFU7.png",
    "noticia": "<p>Teste #2</p>",
    "urlExterna": null,
    "podeComentar": 1,
    "tag": {
      "tagNoticia": "[NOVIDADE 2]",
      "tagCor": "darkblue"
    },
    "comentarios": [
      {
        "comentador": "Trow_Games",
        "comentario": "Muito feliz pela atualização!",
        "idComentario": 1,
        "timestamp": 1593452480
      },
      {
        "comentador": "API_DOCS",
        "comentario": "Teste de comentário para DOCUMENTAÇÃO DE API",
        "idComentario": 2,
        "timestamp": 1605742052
      }
    ]
  },
  "postadoEm": "1593450069"
}

400 Caso a notícia tenha os comentários bloqueados, este será o retorno:

{
    "msg": "noticia_comentario_bloqueado"
}