choose_language

Autoryzacja

Każde z zapytań wysyłanych do API asystenta musi zawierać odpowiednie nagłówki autoryzujące dostęp.
X-AUTH-USER: adres email użytkownika
X-AUTH-DEVICE: identyfikator urządzenia
X-AUTH-FINGERPRINT: jednoznaczny odcisk urządzenia

Kalendarz

GET /app/calendar/week/{date} Zwraca pierwszy dzień tygodnia, ostatni dzień tygodnia, numer zadanego dnia i wydarzenia w trakcie wybranego tygodnia.

Parametry zapytania

Nazwa Typ Wymagany Opis
date string Data w formacie YYYY-MM-DD, dla której chcemy pobrać dane.

Odpowiedzi

Success response

{
firstDay: "2020-03-30 00:00:00",
lastDay: "2020-04-05 23:59:59",
numberOfDay: 7,
results: {
2021-02-03: [
{
id: "624ea72392591e813a65",
time: 1602878400,
length: 60,
description: "Test",
participants: null,
place: null,
repeat: "daily",
type: "remainder",
},
],
},
}
GET /app/calendar/dates Zwraca wszystkie daty w kalendarzu, w których występuje jakiekolwiek zdarzenie.

Odpowiedzi

Success response

[
"2020-03-30",
"2020-06-13",
]
POST /app/calendar/event Tworzy nowy wpis w kalendarzu.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
date string Data w formacie YYYY-MM-DD.
time string Czas w formacie HH:MM.
length int Długość wydarzenia w minutach.
description string Opis wpisu.
type string Typ wpisu. Dostępne wartości: event (domyślny), remainder.
repeat string Powtarzanie wpisu. Dostępne opcje: daily, weekly, monthly, yearly.
place string Miejsce wpisu.
participants string Lista uczestników.

Odpowiedzi

Success response

{
status: "success",
}
GET /app/calendar/event/{eventId} Zwraca wpis z kalendarza.

Parametry zapytania

Nazwa Typ Wymagany Opis
eventId string Identyfikator wpisu.

Odpowiedzi

Success response

{
id: "624ea72392591e813a65",
time: 1602878400,
length: 60,
description: "Test",
participants: null,
place: null,
repeat: "daily",
type: "remainder",
}

Parametry odpowiedzi

Nazwa Typ Pusty (null) Opis
time integer Czas wydarzenia według strefy czasowej UTC.
PUT /app/calendar/event/{eventId} Edytuje wpis z kalendarza.

Parametry zapytania

Nazwa Typ Wymagany Opis
eventId string Identyfikator wpisu.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
date string Data w formacie YYYY-MM-DD.
time string Czas w formacie HH:MM.
length int Długość wydarzenia w minutach.
description string Opis wpisu.
type string Typ wpisu. Dostępne wartości: event (domyślny), remainder.
repeat string Powtarzanie wpisu. Dostępne opcje: daily, weekly, monthly, yearly.
place string Miejsce wpisu.
participants string Lista uczestników.

Odpowiedzi

Success response

{
status: "success",
}
DELETE /app/calendar/event/{eventId} Usuwa wpis z kalendarza.

Parametry zapytania

Nazwa Typ Wymagany Opis
eventId string Identyfikator wpisu.

Odpowiedzi

Success response

{
status: "success",
}
GET /app/calendar/subscribed/week/{date} Zwraca wydarzenia w trakcie całego tygodnia, w którym występuje podany dzień tygodnia.

Parametry zapytania

Nazwa Typ Wymagany Opis
date string Data w formacie YYYY-MM-DD, dla której chcemy pobrać dane.

Odpowiedzi

Success response

{
2021-02-01: [
{
id: "624ea72392591e813a65_624ea72392591e813a65",
time: 1602878400,
length: 60,
description: "Test",
participants: null,
place: null,
repeat: null,
type: "subscribed",
color: "red",
},
],
2021-02-02: [
],
2021-02-03: [
],
2021-02-04: [
],
2021-02-05: [
],
2021-02-06: [
],
2021-02-07: [
],
}

Notes

GET /app/note/list Zwraca listę wszystkich notatek.

Odpowiedzi

Success response

[
{
id: "c9f0f895fb98ab9519f5",
title: "Lista zakup⧹u00f3w",
},
{
id: "6512bd43d9caa6e0c399",
title: "Prezenty",
},
]
POST /app/note Tworzy nową notatkę.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
content string Treść notatki.

Odpowiedzi

Success response

{
status: "success",
id: "4a73e8b3ad7856bdd01a",
}
GET /app/note/{noteId} Zwraca informacje o wybranej notatce.

Parametry zapytania

Nazwa Typ Wymagany Opis
noteId string Identyfikator notatki.

Odpowiedzi

Success response

{
id: "c9f0f895fb98ab9519f5",
title: "Lista zakup⧹u00f3w",
note: "Lista zakup⧹u00f3w⧹nchleb⧹njajka",
}
PUT /app/note/{noteId} Zapisuje notatkę.

Parametry zapytania

Nazwa Typ Wymagany Opis
noteId string Identyfikator notatki.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
content string Treść notatki.

Odpowiedzi

Success response

{
status: "success",
}
DELETE /app/note/{noteId} Usuwa notatkę.

Parametry zapytania

Nazwa Typ Wymagany Opis
noteId string Identyfikator notatki.

Odpowiedzi

Success response

{
status: "success",
}

Nyumba

GET /app/nyumba/masters Zwraca podpięte do konta urządzenia Nyumba.

Odpowiedzi

Success response


                                                            
                                                    
GET /app/nyumba/master/{masterId}/scenes Zwraca sceny zdefiniowane na wybranym urządzeniu.

Parametry zapytania

Nazwa Typ Wymagany Opis
masterId string Identyfikator urządzenia.

Odpowiedzi

Success response

{
5bc3bc2531625963419900: {
id: "5bc3bc2531625963419900",
name: "Scene 1",
commands: "led on",
},
}
POST /app/nyumba/master/{masterId}/instructions Przesyła instrukcje do wybranego urządzenia.

Parametry zapytania

Nazwa Typ Wymagany Opis
masterId string Identyfikator urządzenia.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
instructions array Tablica poleceń do przesłania.

Odpowiedzi

Success response

{
status: "success",
}

Listy ToDo

GET /app/todo/lists Zwraca listę list ToDo wraz z zadaniami.

Odpowiedzi

Success response

{
id: "exampleListId",
name: "Example List",
items: [
{
checked: true,
name: "Item 1",
time: null,
remind_me: false,
},
],
}
PATCH /app/todo/item/{listId}/{itemId} Zmienia status wybranego zadania z listy.

Parametry zapytania

Nazwa Typ Wymagany Opis
listId string Identyfikator listy, na której chcemy zmienić element.
itemId string Pozycja zmienianego elementy (liczona od 0).

Odpowiedzi

Success response

{
status: "success",
}
POST /app/todo/list/new Tworzy nową pustą listę.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
name string Nazwa nowej listy.

Odpowiedzi

Success response

{
status: "success",
}
DELETE /app/todo/list/{listId} Usuwa wybraną listę.

Parametry zapytania

Nazwa Typ Wymagany Opis
listId string Identyfikator listy.

Odpowiedzi

Success response

{
status: "success",
}
POST /app/todo/list/{listId}/items/new Tworzy nowy element na liście.

Parametry zapytania

Nazwa Typ Wymagany Opis
listId string Identyfikator listy.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
name string Nazwa nowego elementu.

Odpowiedzi

Success response

{
status: "success",
}

Finanse

GET /app/finance/categories Zwraca listę kategorii finansów.

Odpowiedzi

Success response

[
"food",
"party",
]
PUT /app/finance/categories Zapisuje listę kategorii finansów.

Odpowiedzi

Success response

{
status: "success",
}
GET /app/finance/{year}/{month} Zwraca dane dotyczące finansów dla wybranego okresu.

Parametry zapytania

Nazwa Typ Wymagany Opis
year integer Rok.
month integer Miesiąc.

Odpowiedzi

Success response

{
limit: 100,
flat: 0,
bills: 0,
food: 0,
party: 0,
education: 0,
other: 0,
}
PUT /app/finance/{year}/{month} Zapisuje dane dotyczące finansów dla wybranego okresu.

Parametry zapytania

Nazwa Typ Wymagany Opis
year integer Rok.
month integer Miesiąc.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
{data} array Dane dotyczące aktywności fizycznej w formacie podobnym do zwracanego przez endpoint GET.

Odpowiedzi

Success response

{
status: "success",
}

IMid

POST /app/imid/authorize Autoryzuje logowanie w systemie IMid.

Odpowiedzi

Success response

{
status: "success",
}

Przepisy

GET /app/recipe/list Zwraca listę przepisów użytkownika oraz publicznych przepisów.

Odpowiedzi

Success response

[
{
id: 1,
name: "Example recipe",
},
]
POST /app/recipe Zapisuje nowy przepis użytkownika.

Odpowiedzi

Success response (przepis użytkownika)

{
status: "success",
}
GET /app/recipe/{recipeId} Zwraca przepis użytkownika lub publiczny przepis.

Parametry zapytania

Nazwa Typ Wymagany Opis
recipeId integer Identyfikatopr przepisu.

Odpowiedzi

Success response (przepis użytkownika)

{
id: 1,
name: "Example recipe",
ingredients: "Water",
recipe: "Boil water",
public: true,
}

Success response (przepis publiczny)

{
id: 1,
name: "Example recipe",
ingredients: "Water",
recipe: "Boil water",
}
PUT /app/recipe/{recipeId} Zapisuje przepis użytkownika.

Parametry zapytania

Nazwa Typ Wymagany Opis
recipeId integer Identyfikatopr przepisu.

Odpowiedzi

Success response

{
status: "success",
}
DELETE /app/recipe/{recipeId} Usuwa przepis użytkownika.

Parametry zapytania

Nazwa Typ Wymagany Opis
recipeId integer Identyfikatopr przepisu.

Odpowiedzi

Success response

{
status: "success",
}

Fit

GET /app/fit/{year}/{month} Zwraca dane dotyczące aktywności fizycznej dla wybranego okresu.

Parametry zapytania

Nazwa Typ Wymagany Opis
year integer Rok.
month integer Miesiąc.

Odpowiedzi

Success response

[
{
date: "2020-10-13",
weight_1: 50.5,
weight_2: 52.6,
description: null,
target: null,
},
]
PUT /app/fit/{year}/{month} Zapisuje dane dotyczące aktywności fizycznej dla wybranego okresu.

Parametry zapytania

Nazwa Typ Wymagany Opis
year integer Rok.
month integer Miesiąc.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
{data} array Dane dotyczące aktywności fizycznej w formacie podobnym do zwracanego przez endpoint GET.

Odpowiedzi

Success response

{
status: "success",
}

Ogólne

POST /query Zwraca odpowiedź asystenta na zadane pytanie.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
query string Treść zapytania do asystenta.

Odpowiedzi

Success response

{
status: "success",
query: "Powiedz test",
answer: "Test.",
html: "<strong>Kod HTML</strong>",
data: "nazwa_pliku_obrazu",
instruction: "img",
}
GET /info Zwraca aktualne ustawienia asystenta.

Odpowiedzi

Success response

{
name: "Assistant",
color: "#ff8800",
time: {
timestamp: 1586118998,
user: "2020-04-05 22:36:38",
utc: "2020-04-05 20:36:38",
},
}
GET /image/{fileName} Zwraca odpowiedź dodatkową asystenta w formie obrazu.

Parametry zapytania

Nazwa Typ Wymagany Opis
fileName string Identyfikator obrazu.
POST /login Loguje uzytkownika na podstawie danych z systemu IMid.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
token string Token uwierzytelniający z systemu IMid.
fingerprint string Unikalny identyfikator urządzenia.

Odpowiedzi

Success response

{
status: "success",
user: "mail@domain.example",
device: "e1d93a6543eb4d1",
}
POST /speech Zwraca nazwę pliku z głosową odpowiedzią asystenta. Plik można pobrać z adresu /voice/nazwa_pliku_z_response.mp3

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
text string Tekst do przetworzenia na mowę.

Odpowiedzi

Success response

{
status: "success",
file: "przykladowanazwapliku.mp3",
}
GET /user Zwraca informacje o użytkowniku.

Odpowiedzi

Success response

{
email: "mail@domain.example",
name: "Leonard Kowalski",
sex: "male",
city: "Warszawa",
timezone: 1,
subscription: "standard",
imid: [
"andra",
],
}
GET /documentation Dokumentacja API.

Notyfikacje

GET /notifications Zwraca listę notyfikacji dla użytkownika.

Odpowiedzi

Success response

{
new: [
{
id: "c509e0c95c99ae573686",
time: 1485946800,
message: "Example 1",
},
],
unread: [
{
id: "f6dd98c2bb3e51bee8c6",
time: 1486185300,
message: "Example 2",
},
],
}
PATCH /notifications/set-as-read/{notification} Ustawia notyfikację jako przeczytaną.

Parametry treści zapytania

Nazwa Typ Pusty (null) Wymagany Opis
notification string Identyfikator notyfikacji.

Odpowiedzi

Success response

{
status: "success",
}

Synchronizacja

GET /sync/calendar/ical/{token} Zwraca kalendarz użytkownika w formacie ical.

Parametry zapytania

Nazwa Typ Wymagany Opis
token string Unikalny token dostępowy do kalendarza użytkownika.

Urządzenia

GET /devices Zwraca listę urządzeń.

Odpowiedzi

Success response

[
{
id: 123,
name: "Device",
type: 1,
},
]
PUT /devices/{deviceId} Edytuje nazwę wybranego urządzenia.

Parametry zapytania

Nazwa Typ Wymagany Opis
deviceId string Identyfikator urządzenia.

Odpowiedzi

Success response

{
status: "success",
}
DELETE /devices/{deviceId} Usuwa wybrane urządzenie.

Parametry zapytania

Nazwa Typ Wymagany Opis
deviceId string Identyfikator urządzenia.

Odpowiedzi

Success response

{
status: "success",
}

Kontakt

Ta strona używa plików cookies. Jeśli nie chcesz, aby pliki cookies były zapisywane na Twoim dysku, zmień ustawienia swojej przeglądarki. Polityka cookies

table_of_content