API

 

API Website Agenda Cultural de Lisboa

agendalx.pt providencia uma API simples para obter a lista dos eventos presentes na agenda.

V1

Para a versão v1 estão disponíveis 2 métodos (um para obter a lista dos eventos e outro para aceder à informação específica de um evento em particular).

Por omissão, o método a usar para pedidos à API é o método GET do protocolo http. A autenticação, por enquanto, é inexistente. Deve ser utilizado um user-agent relevante à aplicação que invoca a API.

Métodos

Obter a lista dos eventos futuros

URL: https://www.agendalx.pt/wp-json/agendalx/v1/events 
Argumentos: nenhum
Resposta: A lista de objectos que descrevem os próximos eventos.

Resposta exemplo:

json
[
  {
    "id": 2735,
    "type": "event",
    "title": {
        "rendered": "Núcleo Arqueológico"
    },
    "featured_media_large": "https://www.agendalx.pt/content/uploads/2020/12/nucleo-arqueologico-Castelo.jpg",
    "subtitle": [
        "Visitas Orientadas"
    ],
    "subject": "ciência, visitas guiadas",
    "string_dates": [
        "15 dezembro 2020 a 31 dezembro 2021"
    ],
    "string_times": "",
    "description": [
        "Visita orientada ao conjunto de vestígios arqueológicos que testemunham três períodos significativos da história de Lisboa: as primeiras ocupações conhecidas que remontam ao século VII a.C.; os vestígios da zona residencial de época islâmica, da época de construção do castelo, de meados do século XI e às ruínas da última residência palaciana da antiga alcáçova, destruída pelo terramoto de Lisboa de 1755."
    ],
    "venue": {
        "castelo-de-sao-jorge": {
            "id": 686,
            "slug": "castelo-de-sao-jorge",
            "name": "Castelo de São Jorge"
        }
    },
    "categories_name_list": {
        "ciencia": {
            "id": 39,
            "slug": "ciencia",
            "name": "ciência"
        },
        "visitas-guiadas": {
            "id": 44,
            "slug": "visitas-guiadas",
            "name": "visitas guiadas"
        }
    },
    "tags_name_list": [],
    "link": "https://www.agendalx.pt/events/event/a-descoberta-do-castelo/",
    "occurences": [
        "2019-05-01",
        "2019-05-05",
        "...",
        "2021-12-30",
        "2021-12-31"
    ],
    "StartDate": "2021-04-08",
    "LastDate": "2021-12-31",
    "price_cat": [
        "value"
    ],
    "price_val": [
        "a:1:{i:0;a:1:{s:11:\"description\";s:50:\"Visita incluída no bilhete do Castelo de S. Jorge\";}}"
    ],
    "target_audience": [],
    "accessibility": []
 },

 


Obter um evento específico através do seu ID

URL: https://agendalx.pt/wp-json/agendalx/v1/events/<ID>
Argumentos: nenhum
Resposta: A informação sobre o objecto com o ID especificado.