1. Κέντρο βοηθείας
  2. API & 3rd party εφαρμογές
  3. Κατηγορίες Api

Κατηγορίες Api

Χρησιμοποιήστε το API κατηγορίας για να εξαγάγετε πληροφορίες σχετικά με κατηγορίες, να προσθέσετε νέες κατηγορίες ή να ενημερώσετε δεδομένα για υπάρχουσες κατηγορίες.

  • Διαθέσιμα πεδία
  • Εξαγάγετε τη λίστα κατηγοριών
  • Εξαγωγή δεδομένων κατηγορίας
  • Προσθήκη κατηγορίας
  • Τροποποίηση δεδομένων κατηγορίας
  • Διαγραφή κατηγοριών

Διαθέσιμα πεδία

Η παρακάτω λίστα δείχνει όλα τα διαθέσιμα πεδία για αυτό το API, τα οποία επιστρέφονται όταν εξαγάγετε μια μεμονωμένη λίστα ή πόρο, οι οποίοι μπορούν να τροποποιηθούν, οι οποίοι είναι υποχρεωτικοί κατά τη δημιουργία ενός νέου πόρου ή την ενημέρωση ενός υπάρχοντος πόρου.

Κωδικός περιγραφής

Υπόδειξη

Περιγραφή

Lista

Μεταβλητός

ταυτότητα

int

Αναγνωριστικό κατηγορίας

 

όνομα

σειρά

Όνομα κατηγορίας

περιγραφή

σειρά

Περιγραφή κατηγορίας

meta_title

σειρά

Τίτλος μετα-κατηγορίας

meta_description

σειρά

Μετα-περιγραφή της κατηγορίας

γονέα_id

int

Αναγνωριστικό κατηγορίας γονέα

σελίδα_προτύπου

σειρά

Ο τύπος προτύπου που χρησιμοποιείται για προβολή στην περίπτωση κατηγοριών που περιέχουν υποκατηγορίες (προϊόντα, υποκατηγορίες, μικτές, επισημάνσεις)

meta_fields

αντικείμενο

Πρόσθετα πεδία

url

σειρά

URL κατηγορίας

 

meta_links

αντικείμενο

URL κατηγορίας ενεργής γλώσσας

 

 

υποκατηγορίες

πίνακας

Λίστα αναγνωριστικών υποκατηγορίας

 

 

Ημερομηνία Δημιουργίας

ημερομηνία

Κατηγορία προσθήκης ημερομηνίας (μορφή ISO 8601)

 

κατάσταση

σειρά

Κατάσταση εγγραφής (ενεργή, ανενεργή)

ΥΠΟΔΕΙΞΗ

Τυχόν επιστρεφόμενα και χωρίς έγγραφα πεδία μπορούν να αγνοηθούν επειδή δεν είναι ακόμη διαθέσιμα.

Εξαγάγετε τη λίστα κατηγοριών

Εμφανίζει τη φιλτραρισμένη λίστα εγγραφών.

Τύπος : Λίστα πόρων
ρήμα : GET
Διεύθυνση URL : /api/v2/categories
Αποτελέσματα φίλτρου : Ναι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Ναι
Σελίδα : Ναι

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή μιας λίστας πόρων που σχετίζονται με τα καθορισμένα φίλτρα.

Μόνο τα πεδία λίστας θα συμπεριληφθούν στο τυπικό αποτέλεσμα. Μπορείτε να συμπεριλάβετε επιπλέον πεδία που δεν περιλαμβάνονται από προεπιλογή χρησιμοποιώντας την παράμετρο includeκαι αναφέρετε ρητά μόνο τα πρόσθετα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν.

GET /api/v2/categories?include=subcategories

Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο fieldsκαι αναφέροντας ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο idθα περιλαμβάνεται πάντα από προεπιλογή).

GET /api/v2/categories?fields=id,name,parent_id

Φιλτράρισμα αποτελεσμάτων

Είναι δυνατό να φιλτράρετε τα αποτελέσματα προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.

Παράμετρος

Περιγραφή

Παράδειγμα

ταυτότητα

Αναγνωριστικό κατηγορίας

id = 101

αναγνωριστικά

Λίστα αναγνωριστικών κατηγορίας διαχωρισμένων με κόμμα

ids = 101,102,103

γονέα_id

Αναγνωριστικό κατηγορίας γονέα

γονέα_id = 101

meta_fields

Πρόσθετα πεδία

meta_fields [field_key] = τιμή_ πεδίου

δημιουργήθηκε μετά

Ημερομηνία δημιουργίας των εγγραφών (μορφή ISO 8601)

create_after = 2019-01-01

δημιουργήθηκε πριν

Ημερομηνία έως την οποία δημιουργήθηκαν οι εγγραφές (μορφή ISO 8601)

δημιουργήθηκε_πριν = 2020-01-01

κατάσταση

Κατάσταση εγγραφής (ενεργή, ανενεργή)

κατάσταση = ενεργό

GET /api/v2/categories?parent_id=0&status=active

Ταξινόμηση αποτελεσμάτων

Είναι δυνατή η ταξινόμηση των αποτελεσμάτων προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.

Παράμετρος

Περιγραφή

Παράδειγμα

όνομα

Ανερχόμενο όνομα κατηγορίας

είδος = όνομα

όνομα.desc

Φθίνουσα ονομασία κατηγορίας

είδος = όνομα.desc

Ημερομηνία Δημιουργίας

Ημερομηνία ανόδου της κατηγορίας

ταξινόμηση = ημερομηνία_δημιουργήθηκε

date_created.desc

Ημερομηνία προσθήκης της φθίνουσας κατηγορίας

sort = date_created.desc

ορισμένο από τον χρήστη

Ανάλογα με τα κριτήρια παραγγελίας κατηγορίας που ορίζονται σε επίπεδο Cpanel

ταξινόμηση = user_defined

GET /api/v2/categories?sort=name

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

Οι παράμετροι σελιδοποίησης μπορούν να προστεθούν στο αίτημα API για περιορισμό του αριθμού καταχωρήσεων ανά σελίδα και πρόσβαση σε όλες τις διαθέσιμες σελίδες.

Παράμετρος

Υπόδειξη

Προκαθορισμένο

αρχή

int

0

όριο

int

100

Το μέγιστο όριο εγγραφής ανά σελίδα δεν μπορεί να υπερβαίνει τα 100.

GET /api/v2/categories?start=100&limit=100

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που εξάγει όλες τις εγγραφές:

curl --request GET \
--url 'https://shop.demo.ro/api/v2/categories' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Εξαγωγή όλων των εγγραφών, εξαγωγή όλων των πεδίων

Παράδειγμα αιτήματος

GET /api/v2/categories

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 101,
      "name": "Men",
      "description": "Best online clothing shops for men",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "page_template": "subcategories"
    },
    {
      "id": 102,
      "name": "Women",
      "description": "Women clothing in all styles and sizes",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "page_template": "subcategories"
    },
    {
      "id": 103,
      "name": "Accessories",
      "description": "Find a wide selection of accessories for men & women",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "page_template": "subcategories"
    },    
    {
      "id": 1011,
      "name": "Pants",
      "description": "Explore the new collection of men pants",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00"
    },
    {
      "id": 1012,
      "name": "Shirts",
      "description": "Discover our stylish men's shirts",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00"
    },
    {
      "id": 1013,
      "name": "Shoes",
      "description": "The most stylish and comfortable men's shoes",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00"
    },
    { ... },
  ],
  "meta": {
    "count": {
      "total": 50,
      "current": 50,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/categories",
      "next": null
    }
  }
}

Εξαγάγετε όλες τις εγγραφές, φιλτράρετε μόνο συγκεκριμένα πεδία

Παράδειγμα αιτήματος

GET /api/v2/categories?fields=id,name,parent_id

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 101,
      "name": "Men",
      "parent_id": 0
    },
    {
      "id": 102,
      "name": "Women",
      "parent_id": 0
    },
    {
      "id": 103,
      "name": "Accessories",
      "parent_id": 0
    },    
    {
      "id": 1011,
      "name": "Pants",
      "parent_id": 101
    },
     {
      "id": 1012,
      "name": "Shirts",
      "parent_id": 101
    },
    {
      "id": 1013,
      "name": "Shoes",
      "parent_id": 101
    },
    { ... },
  ],
  "meta": {
    "count": {
      "total": 50,
      "current": 50,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/categories",
      "next": null
    }
  }
}

Εξαγάγετε όλες τις εγγραφές, συμπεριλάβετε επιπλέον πεδία

Παράδειγμα αιτήματος

GET /api/v2/categories?include=url

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 101,
      "name": "Men",
      "description": "Best online clothing shops for men",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/men",
      "page_template": "subcategories"
    },
    {
      "id": 102,
      "name": "Women",
      "description": "Women clothing in all styles and sizes",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/women",
      "page_template": "subcategories"
    },
    {
      "id": 103,
      "name": "Accessories",
      "description": "Find a wide selection of accessories for men & women",
      "status": "active",
      "parent_id": 0,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/accessories",
      "page_template": "subcategories"
    },    
    {
      "id": 1011,
      "name": "Pants",
      "description": "Explore the new collection of men pants",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/men-pants"
    },
    {
      "id": 1012,
      "name": "Shirts",
      "description": "Discover our stylish men's shirts",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/men-shirts"
    },
    {
      "id": 1013,
      "name": "Shoes",
      "description": "The most stylish and comfortable men's shoes",
      "status": "active",
      "parent_id": 101,
      "meta_title": null,
      "meta_description": null,
      "date_created": "2020-01-01T01:01:01+02:00",
      "url": "https://shop.demo.ro/men-shoes"
    },
    { ... },
  ],
  "meta": {
    "count": {
      "total": 50,
      "current": 50,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/categories",
      "next": null
    }
  }
}

Φιλτράρετε εγγραφές βάσει λίστας αναγνωριστικών, φιλτράρετε μόνο συγκεκριμένα πεδία

Παράδειγμα αιτήματος

GET /api/v2/categories?ids=101,102&fields=id,name

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 101,
      "name": "Men"
    },
    {
      "id": 102,
      "name": "Women"
    }
  ],
  "meta": {
    "count": {
      "total": 2,
      "current": 2,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/categories",
      "next": null
    }
  }
}

Εξαγωγή δεδομένων κατηγορίας

Εμφανίζει τα δεδομένα μιας μεμονωμένης εγγραφής.

Τύπος : Ατομικός πόρος
ρήμα : GET
Διεύθυνση URL : /api/v2/categories/{id}
Αποτελέσματα φίλτρου : Όχι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Όχι
Σελίδα : Όχι

Ο κωδικός απόκρισης http είναι 200σε περίπτωση επιτυχίας, η απάντηση θα έχει τη μορφή ενός μεμονωμένου πόρου που σχετίζεται με το αναγνωριστικό που ζητήσατε.

Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο fieldsκαι αναφέροντας ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο id θα συμπεριλαμβάνεται πάντα από προεπιλογή).

GET /api/v2/categories/{id}?fields=id,name,parent_id

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που επιστρέφει μια μεμονωμένη εγγραφή:

curl --request GET \
--url 'https://shop.demo.ro/api/v2/categories/101' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Εξαγωγή όλων των πεδίων

Παράδειγμα αιτήματος

GET /api/v2/categories/101

Παράδειγμα απάντησης

{
  "id": 101,
  "name": "Men",
  "description": "Best online clothing shops for men",
  "status": "active",
  "parent_id": 0,
  "meta_title": null,
  "meta_description": null,
  "date_created": "2020-01-01T01:01:01+02:00",
  "meta_fields": {
    "homepage_display": "on"
  },
  "subcategories": [
    1011,
    1012,
    1013
  ],
  "url": "https://shop.demo.ro/men",
  "meta_links": {
    "en_US": {
      "lang": "en_US",
      "url": "https://shop.demo.ro/en/men"
    }
  },
  "page_template": "subcategories"
}

Φιλτράρετε μόνο ορισμένα πεδία

Παράδειγμα αιτήματος

GET /api/v2/categories/101?fields=id,name,subcategories

Παράδειγμα απάντησης

{
  "id": 101,
  "name": "Men",
  "subcategories": [
    1011,
    1012,
    1013
  ]
}

Προσθήκη κατηγορίας

Σας επιτρέπει να προσθέσετε μια νέα εγγραφή.

Τύπος : Δυναμικού Δημιουργία
ρήμα : POST
Url :/api/v2/categories

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που θα αντιπροσωπεύει την εγγραφή που μόλις προστέθηκε.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που δημιουργεί μια νέα εγγραφή:

curl --request POST \
--url 'https://shop.demo.ro/api/v2/categories' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
  "name": "Women",
  "description": "Women clothing in all styles and sizes",
  "parent_id": 102
}'

Προσθήκη κατηγορίας ρίζας

Παράδειγμα αιτήματος

POST /api/v2/categories

{
  "name": "Women",
  "description": "Women clothing in all styles and sizes",
  "parent_id": 0  
}

Παράδειγμα απάντησης

{
  "id": 102,
  "name": "Women",
  "description": "Women clothing in all styles and sizes",
  "status": "active",
  "parent_id": 0,
  "meta_title": null,
  "meta_description": null,
  "date_created": "2020-01-01T01:01:01+02:00",
  "meta_fields": null,
  "subcategories": null,
  "url": "https://shop.demo.ro/women",
  "meta_links": {
    "en_US": {
      "lang": "en_US",
      "url": "https://shop.demo.ro/en/women"
    }
  }
}

Προσθέστε υποκατηγορία και επιπλέον πεδία

Παράδειγμα αιτήματος

POST /api/v2/categories

{
  "name": "Pants",
  "description": "Explore the new collection of men pants",
  "status": "active",
  "parent_id": 101,
  "meta_fields": {
    "homepage_display": "on"
  }
}

Παράδειγμα απάντησης

{
  "id": 1011,
  "name": "Pants",
  "description": "Explore the new collection of men pants",
  "status": "active",
  "parent_id": 101,
  "meta_title": null,
  "meta_description": null,
  "date_created": "2020-01-01T01:01:01+02:00",
  "meta_fields": {
    "homepage_display": "on"
  },
  "subcategories": null,
  "url": "https://shop.demo.ro/men-pants",
  "meta_links": {
    "en_US": {
      "lang": "en_US",
      "url": "https://shop.demo.ro/en/men-pants"
    }
  }
}

Τροποποίηση δεδομένων κατηγορίας

Σας επιτρέπει να ενημερώσετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού.

Τύπος : Δυναμικού Ενημέρωση
ρήμα : PATCH
Url :/api/v2/categories/{id}

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που αντιπροσωπεύει την εγγραφή που μόλις ενημερώθηκε.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που ενημερώνει μια υπάρχουσα εγγραφή:

curl --request PATCH \
--url 'https://shop.demo.ro/api/v2/categories/101' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
  "description": "Best online clothing shops for men",
  "meta_title": "Men Clothing & Shoes"
}'

Ενημέρωση δεδομένων κατηγορίας

Παράδειγμα αιτήματος

PATCH /api/v2/categories/101

{
  "meta_title": "Men Clothing & Shoes",
  "meta_fields": {
    "homepage_display": "off"
  },
}

Παράδειγμα απάντησης

{
  "id": 101,
  "name": "Men",
  "description": "Best online clothing shops for men",
  "status": "active",
  "parent_id": 0,
  "meta_title": "Men Clothing & Shoes",
  "meta_description": null,
  "date_created": "2020-01-01T01:01:01+02:00",
  "meta_fields": {
    "homepage_display": "off"
  },
  "subcategories": [
    1011,
    1012,
    1013
  ],
  "url": "https://shop.demo.ro/men",
  "meta_links": {
    "en_US": {
      "lang": "en_US",
      "url": "https://shop.demo.ro/en/men"
    }
  },
  "page_template": "subcategories"
}

Αλλαγή κατάστασης κατηγορίας

Παράδειγμα αιτήματος

PATCH /api/v2/categories/101

{
  "status": "inactive"
}

Παράδειγμα απάντησης

{
  "id": 101,
  "name": "Men",
  "description": "Best online clothing shops for men",
  "status": "inactive",
  "parent_id": 0,
  "meta_title": null,
  "meta_description": null,
  "date_created": "2020-01-01T01:01:01+02:00",
  "meta_fields": {
    "homepage_display": "on"
  },
  "subcategories": [
    1011,
    1012,
    1013
  ],
  "url": "https://shop.demo.ro/men",
  "meta_links": {
    "en_US": {
      "lang": "en_US",
      "url": "https://shop.demo.ro/en/men"
    }
  },
  "page_template": "subcategories"
}

Διαγραφή κατηγοριών

Σας επιτρέπει να διαγράψετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού. Αυτό περιλαμβάνει επίσης τη διαγραφή όλων των πρόσθετων πληροφοριών.

Τύπος : Διαγραφή πόρου
ρήμα : DELETE
Url :/api/v2/categories/{id}

Ο κωδικός απόκρισης http είναι 200επιτυχής.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL διαγραφής υπάρχουσας εγγραφής:

curl --request DELETE \
--url 'https://shop.demo.ro/api/v2/categories/101' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Παράδειγμα αιτήματος

DELETE /api/v2/categories/101

Παράδειγμα απάντησης

{
  "ok": true
}
Τελευταία τροποποίηση: 30 Jun 2021
Ήταν χρήσιμη αυτή η σελίδα;
Χρειάζεστε ακόμα βοήθεια;