API‎ > ‎

API

Využitím API se můžete dostat k surovým datům, která používáme na generování reportů. Každý vygenerovaný report máme historicky uložený a díky API se tak můžete dostat jak k datům využitých v posledním reportu, tak k datům historickým.

Technická specifikace

Přihlášení uživatele

[POST] https://app.trendlucid.com/profile/sign_in.json
{
"user": {
        "email": "adam@trendlucid.com",
        "password": "MojeNejbezpecnejsiHeslo",
        "remember_me": 1
}
}

Požadavek mimo jiné vrátí token daného uživatele, pomocí kterého se pak autorizují další požadavky na API

{
  "id": 13,
  "name": "Adam Tomeček",
  "email": "adam@trendlucid.com",
  "created_at": "2016-05-31T09:34:39.000+02:00",
  "updated_at": "2017-02-20T14:20:29.000+01:00",
  "agency_id": null,
  "organization_id": null,
  "authentication_token": "xxxxxxxxxxxxxxxxxxxxx"
}

Token se dále předává v HTTP hlavičce v každém požadavku

X-User-Email adam@trendlucid.com
X-User-Token xxxxxxxxxxxxxxxxxxx

Seznam reportů

[GET] https://app.trendlucid.com/api/report_configs.json

Vrátí seznam všech reportů, ke kterým má přístup zvolený uživatelský účet

[
  {
    "id": 42,
    "shop_url": "nejelpsieshop.cz",
    "file_name": "",
    "area_name": "Elektronika",
    "last_report_send": "2017-01-01T03:00:00.000+02:00",
    "categories_count": 35,
    "competition_count": 12
  },
  {
    "id": 666,
    "shop_url": "nejelpsieshop.cz",
    "file_name": "",
    "area_name": "Bílé zboží",
    "last_report_send": "2017-01-01T03:00:00.000+02:00",
    "categories_count": 5,
    "competition_count": 7
  }
]

Uložené záznamy

[GET] https://app.trendlucid.com/api/stored_reports.json?report_config_id=42

Vrátí seznam všech historicky uložených záznamů pro konkrétní report

[
  {
    "id": "627cf6040092d5ae1789c455735df0c8791145e2",
    "report_config_id": 42,
    "shop_url": "nejelpsieshop.cz",
    "area_name": "Elektronika",
    "file_name": null,
    "generated_at": "2017-02-14T11:44:37.000+00:00"
  },
  {
    "id": "4eebe89ef95a7a6b3fc3095eaa4ecd2ee58718fd",
    "report_config_id": 42,
    "shop_url": "nejelpsieshop.cz",
    "area_name": "Elektronika",
    "file_name": null,
    "generated_at": "2017-01-24T10:41:15.000+00:00"
  }
]

Data pro preport

[GET] https://app.trendlucid.com/api/last_report_data.json?report_config_id=42
nebo
[GET] https://app.trendlucid.com/api/report_data.json?report_config_id=42&id=627cf6040092d5ae1789c455735df0c8791145e2

A konečně požadavek, který vrátí data pro konkrétní vygenerovaný report (z důvodu velikosti dat výsledky pouze naznačeny). Můžete si vybrat endpoint last_report_data pro poslední snapshot dat daného reportu, nebo report_data pro libovolný snapshot.


{
  "id": "627cf6040092d5ae1789c455735df0c8791145e2",
  "report_config_id": 42,
  "shop_url": "nejelpsieshop.cz",
  "area_name": Elektronika,
  "file_name": null,
  "generated_at": "2017-02-14T12:44:25.378+01:00",
  "data": {
    "categories": [],
    "products": {},
    "cheap_products": [],
    "expensive_products": [],
    "changed_products": [],
    "manufacturers": {},
    "shops_visits": {},
    "categories_visits": {},
    "heureka_reviews": {}
  }
}

Informace o kategoriích

API umí vrátit i zjednodušená data pouze o počtech produktů v kategoriích pro poslední snapshot.

[GET] https://app.trendlucid.com/api/last_report_categories_data.json?report_config_id=42

Výsledek

[
    {
        "name": "Mobilní telefony",
        "url": "http://mobilni-telefony.heureka.cz/",
        "top_products": 200,
        "shop_top_products": 83
    },
    {
        "name": "Notebooky",
        "url": "http://notebooky.heureka.cz/",
        "top_products": 200,
        "shop_top_products": 21
    },
    ...
]
Comments