Documentação



Documentação


API – Mexido de Ideias

CÓDIGOS DE RESPOSTA PADRÃO DA API
  • 200: OK
  • 412: Atributos GET inválidos





Pesquisar Posts por palavra chave

GET

Parâmetros GET

{{search}} /* palavra chave para buscar por título ou descrição */

RESPOSTA
{
  "total_posts": (Int),  /* Total de posts da categoria  */
  "next_page": (String),  /* paginação, próxima pagina */
  "before_page": (String),  /* paginação, página anterior  */
  "posts": [
    {
      "id_post": (Int),  /* ID do posts  */
      "link_post": (String),  /* URL da APi para o post  */
      "title": (String),  /* Título principal do post  */
      "image": {  /* Imagem principal do post  */
        "thumbnail": (String),  /* Url a imagem  */
        "medium": (String),  /* Url a imagem  */
      },
      "content": (Text),  /* Resumo do conteúdo  */
    }
  ]
}





Listar todos os posts

GET

Parâmetros GET

{{limit}} /* Limite de posts retornados, separados com virgula com valores numéricos (Obrigatório) */

RESPOSTA
{
  "total_posts": (Int),  /* Total de posts da categoria  */
  "next_page": (String),  /* paginação, próxima pagina */
  "before_page": (String),  /* paginação, página anterior  */
  "posts": [
    {
      "id_post": (Int),  /* ID do posts  */
      "link_post": (String),  /* URL da APi para o post  */
      "title": (String),  /* Título principal do post  */
      "image": {  /* Imagem principal do post  */
        "thumbnail": (String),  /* Url a imagem  */
        "medium": (String),  /* Url a imagem  */
      },
      "content": (Text),  /* Resumo do conteúdo  */
    }
  ]
}





Listar todos os posts por categoria

GET

Parâmetros GET

{{category}} /* Categoria dos posts (Obrigatório) */
{{limit}} /* Limite de posts retornados, separados com virgula com valores numéricos (Obrigatório) */

/* Filtros apenas para receitas */
{{ingredientes}} (Array) /* IDs do ingredientes (Opcional) */
{{tempo_preparo}} (Array) /* IDs dos tempos de preparo (Opcional) */
{{ocasioes}} (Array) /* IDs das ocasioes (Opcional) */
{{tipos}} (Array) /* IDs do tipos (Opcional) */

Nome categorias:
receitas,
ciencias,
industrias,
cultura,
barista-e-sommelier

RESPOSTA
{
  "total_posts": (Int),  /* Total de posts da categoria  */
  "next_page": (String),  /* paginação, próxima pagina */
  "before_page": (String),  /* paginação, página anterior  */
  "posts": [
    {
      "id_post": (Int),  /* ID do posts  */
      "link_post": (String),  /* URL da APi para o post  */
      "title": (String),  /* Título principal do post  */
      "image": {  /* Imagem principal do post  */
        "thumbnail": (String),  /* Url a imagem  */
        "medium": (String),  /* Url a imagem  */
      },
      "content": (Text),  /* Resumo do conteúdo  */
    }
  ]
}





Retornar post por ID

GET

Parâmetros GET

{{id_post}} /* ID do post (Obrigatório) */

RESPOSTA
{
    "title": (String),  /* Título principal do post  */
    "image": {  /* Imagem principal do post  */
      "thumbnail": (String),  /* Url a imagem  */
      "medium": (String),  /* Url a imagem  */
      "large": (String),  /* Url a imagem  */
      "full": (String),  /* Url a imagem  */
    },
    "content": (Text),  /* Conteúdo principal do post  */
    "ingredients": [  /* Ingredientes da receita  */
      {
        "image": (Array),  /* Url e parâmetros da imagem da receita  */
        "ingredients": { (Array)  /* Todos os ingredientes da receita  */
          "title": (String),  /* Nome do ingrediente  */
          "description": (Text),  /* Descrição do ingrediente  */
        }
      }
    ],
    "preparation": [ (Array)  /* Modo de preparo da receita  */
      {
        "title": "",  /* Título  */
        "steps": [ (Array)  /* Passos do modo de preparo  */
          {
            "image": (Array),  /* Url e parâmetros da imagem do modo de preparo  */
            "description": (Text),  /* Descrição do passo do modo de preparo  */
            "number": (INT),  /* Order do modo de preparo  */
          }
        ]
      }
    ],
    "author": (String)  /* Autor do post  */
}


Deixe seu comentário