URL: https://orbitvu.co/api/v1/presentations [.json|.xml]
Zwrócone dane
Dane zwracane przez ten punkt końcowy to podzielona na strony lista prezentacji i jej zawartość. Na przykład:
{
"count": 1,
"next": null,
"previous": null,
"per_page": 50,
"results": [
{
"id": 46,
"uid": "5Etsw445fEtdGYpKLnTp5b",
"name": "Some presentation",
"sku": "1234",
"category_1": "",
"category_2": "",
"create_date": "2013-02-15T09:45:00",
"ovus_number": "025",
"presentation_size": 11066632,
"has_orbittour": true,
"tags": [],
"url": "https://orbitvu.co/api/presentations/46",
"edit_url": "https://orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/",
"thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
"statistics_url": "https://orbitvu.co/api/v1/presentations/46/statistics",
"orbittour_set": [
{
"id": 1,
"script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/script",
"view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/view"
}
],
"custom_attributes": [
{
"label": "Category 1",
"value": "summer",
}
],
"presentationcontent_set": [
{
"id": 117,
"sorting_order": 1,
"name": "ov3601",
"type": 1,
"type_display": "ORBITVU 360",
"ovus_folder": "https://orbitvu.co/025/5Etsw445fEtdGYpKLnTp5b/ov3601/",
"thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
"script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/script",
"view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/view",
"max_width": 4272,
"max_height": 2848,
"content2_xml": true
},
{
"id": 119,
"sorting_order": 2,
"name": "img_1.jpg",
"type": 3,
"type_display": "image2d",
"ovus_folder": "",
"thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
"script_url": "",
"view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
"max_width": 0,
"max_height": 0,
"content2_xml": ""
},
{
"id": 120,
"sorting_order": 3,
"name": "img_2.jpg",
"type": 3,
"type_display": "image2d",
"ovus_folder": "",
"thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
"script_url": "",
"view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
"max_width": 0,
"max_height": 0,
"content2_xml": ""
}
]
}
]
}
Click to copy
Dane dotyczące paginacji:
- count - liczba wyników
- next - URL do następnej strony wyników (null, jeśli nie ma następnej strony)
- previous - URL do poprzedniej strony wyników (null, jeśli nie ma następnej strony)
- per_page - liczba wyników na stronę (można ustawić za pomocą parametru adresu URL)
- results - liczba wyników (obiekty prezentacji)
Szczegółowy opis danych wynikowych:
- id - unikalny identyfikator prezentacji (numeryczny)
- uid - unikalny identyfikator prezentacji (używany w adresach URL)
- name, SKU, category_1, category_2 - szczegóły prezentacji
- create_date - data utworzenia prezentacji
- ovus_number - liczba używana w parametrze ovus_folder dla treści 360, przydatna do automatycznego generowania ovus_folder
- presentation_size - wielkość prezentacji w bajtach
- has_orbittour - wartość logiczna, która określa, czy w tej prezentacji istnieje ORBITTOUR
- tags - lista tagów dołączonych do prezentacji
- url - bezpośredni adres URL do tego obiektu prezentacji
- edit_url - adres URL strony edycji prezentacji w Orbitvu SUN
- thumbnail_url - URL do obrazu miniatury tej prezentacji; obrazem można manipulować za pomocą parametrów ciągu zapytania, takich jak:
- width - żądana szerokość
- height - żądana wysokość
- max_width - maksymalna szerokość (zachowuje proporcje wysokości)
- max_height - maksymalna wysokość (zachowuje proporcje szerokości)
- action - crop (przycięcie obrazu do konkretnego rozmiaru), supplement (uzupełnienie z białym tłem w celu uzyskania pożądanego rozmiaru)
- statistics_url - URL do statystyk prezentacji
- orbittour_set - lista ORBITTOURów zdefiniowanych do prezentacji (obecnie maksymalnie jeden ORBITTOUR)
- custom_attributes - lista niestandardowych atrybutów zdefiniowanych dla prezentacji
- presentationscontent_set - spis treści prezentacji:
- id - unikalny identyfikator treści prezentacji
- sorting_order - liczba pokazująca kolejność treści
- name - nazwa treści, ov3601 dla kontentu 360, nazwa pliku dla treści 2D
- type - rodzaj zawartości: 1 - zawartość 360°, 3 - obrazy 2D, 4 - video
- type_display - przyjazny opis rodzaju treści
- ovus_folder - ovus_folder URL dla zawartości 360°; pusty dla obrazów 2D
- thumbnail_url - adres URL obrazu (dla treści 2D) lub miniatury (dla treści 360°). Obraz można zamienić za pomocą parametrów ciągu zapytania (jak opisano powyżej)
- script_url - URL do punktu końcowego skryptu dla treści 360°
- view_url - URL do punktu końcowego widoku 360°
- max_width - maksymalna szerokość zawartości 360°
- max_height - maksymalna wysokość zawartości 360°
- content2_xml - wartość logiczna określająca, czy zawartość 360° korzysta z pliku content2.xml
Wyszukiwanie
- exact
Wyszukiwanie prezentacji według dokładnego dopasowania do określonych pól: id, sku, name, uid, tags, np.:
# match presentation with sku == 1234
https://orbitvu.co/api/v1/presentations.json?sku=1234
# match presentation with tag shoes
https://orbitvu.co/api/v1/presentations.json?tags=shoes
Click to copy
- create_date
Wyszukiwanie prezentacji według zakresu dat za pomocą: create_date_from i/lub create_date_to i formatu daty: YYYY-MM-DD, np.:
# Search for presentations created after 2018-01-05: https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-05
# Search for presentations created between 2018-01-01 and 2018-01-05:
https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-01&create_date_to=2018-01-05
Click to copy
- ilike
Wyszukiwanie prezentacji zawierających określony wzór w obrębie określonego: search_sku, search_name, search_uid, search_tags:
# match all presentations with sku containing '123'
https://orbitvu.co/api/v1/presentations?search_sku=123
# match all presentations with tags like 'tag1' or 'tag2'
https://orbitvu.co/api/v1/presentations?search_tags=tag1,tag2
Click to copy
- ilike - szukanie w wielu polach jednocześnie
Wyszukiwanie prezentacji zawierających określony wzorzec w ramach jednego z sku, name, uid:
# match all presentations with sku, name or uid containing 'A123' or 'a123'
https://orbitvu.co/api/v1/presentations?search=A123
Click to copy
Porządek
Porządek poprzez: sku, uid, name:
# ascending
https://orbitvu.co/api/v1/presentations?ordering=sku
# descending
https://orbitvu.co/api/v1/presentations?ordering=-sku
Click to copy
Paginacja
Liczba prezentacji na stronie:
https://orbitvu.co/api/v1/presentations/?page_size=5
Click to copy