FlexyΤεκμηρίωση API

Βασικές έννοιες

Σελιδοποίηση

Τα endpoints που επιστρέφουν λίστες τις επιστρέφουν σε σελίδες.

Ζητάτε συγκεκριμένη σελίδα με δύο query parameters:

ΠαράμετροςΠεριγραφή
pageΟ αριθμός της σελίδας, ξεκινώντας από το 1.
page_sizeΠόσα αποτελέσματα θέλετε ανά σελίδα. Κάθε endpoint έχει δικό του προεπιλεγμένο και μέγιστο όριο.

Το κομμάτι της απάντησης που αφορά τη σελιδοποίηση έχει αυτή τη μορφή:

{
  "metadata": {
    "count": 42,
    "next_cursor": "https://provider-api.flexy.gr/api/v1/...?page=2",
    "previous_cursor": null,
    "page_size": 20
  },
  "results": [
    // τα αντικείμενα αυτής της σελίδας
  ]
}
ΠεδίοΠεριγραφή
metadata.countΤο συνολικό πλήθος αποτελεσμάτων, σε όλες τις σελίδες.
metadata.next_cursorΤο πλήρες URL της επόμενης σελίδας, ή null στην τελευταία σελίδα.
metadata.previous_cursorΤο πλήρες URL της προηγούμενης σελίδας, ή null στην πρώτη σελίδα.
metadata.page_sizeΤο μέγεθος σελίδας.
resultsΤα αποτελέσματα της σελίδας.