Ενσωμάτωση περιεχομένου (API)

Το newsgear.gr σας δίνει τη δυνατότητα να ενσωματώσετε το περιεχόμενο που θα βρείτε στην δική σας ιστοσελίδα ή ιστολόγιο (blog), χρησιμοποιώντας το API και τις παραμέτρους που θα βρείτε παρακάτω.
Το API του newsgear.gr ειναι μια απλή υπηρεσία διαδικτύου (web service) σε JSON ή RSS(XML) μορφή, η οποία δίνει τη δυνατότητα σε οποιονδήποτε προγραμματιστή ή διαχειριστή μιας ιστοσελίδας το επιθυμεί να χρησιμοποιήσει το περιεχόμενο.

*Ένα παράδειγμα ενσωμάτωσης του API σε Wordpress μπορείτε να βρείτε εδώ.

Ενεργοποίηση
Για να χρησιμοποιήσετε το API θα πρέπει ο λογαριασμός σας (το πακέτο της συνδρομής σας) να έχει δικαίωμα χρήσης του, και να ειναι αυτό ενεργοποιημένο στο διαχειριστικό (panel). Στο διαχειριστικό πηγαίνετε στο μενού διαχείρισης και επιλέγετε το: Ρυθμίσεις > Ενσωμάτωση περιεχομένου. Στην αρχή της σελίδας βεβαιωθείτε οτι ειναι ενεργό, διαφορετικά επικοινωνήστε μαζί μας.

Διεύθυνση(URL) του API
Η διεύθυνση του API ειναι στην εξής μορφή:
http://<your-site-name>.nws.gr/api?apikey=<your-apikey>

1. <your-site-name>: ειναι η μοναδική ονομασία της εγκατάστασης σας, με λατινικούς χαρακτήρες, η οποία ορίζεται κατα την αρχική επιβεβαίωση της εγγραφής σας στο newsgear.gr
*Σε περίπτωση χρήσης δικού σας domain name, η διευθυνση του api θα ξεκινάει με αυτό.
2. <your-apikey>: ειναι ο μοναδικός κωδικός χρήσης για το api σας, τον βρίσκετε στη διαχείριση : Ρυθμίσεις > Ενσωμάτωση περιεχομένου (API)

Η χρήση της παραπάνω διεύθυνσης(URL) γίνεται μέσω μιας κλήσης HTTP GET ή POST.

Παράμετροι (API parameters)
apikey: ο μοναδικός κωδικός του API σας, τον βρίσκεται στο διαχειριστικό Ρυθμίσεις > Ενσωμάτωση περιεχομένου (API)
output_type: rss (έκδοση 2.0) ή json (αν δεν ορίσετε τιμή, το περιεχόμενο θα επιστραφεί ώς rss)
keyword: η λέξη κλειδί σας πχ. κυβέρνηση (αν δεν ορίσετε θα επιστραφεί περιεχόμενο για όλες τις λέξεις-κλειδιά σας)
type: article ή social ή video ή all (ο τύπος περιεχομένου που θέλετε, αν δεν ορίσετε θα επιστραφεί περιεχόμενο απο όλους τους τύπους)
stream_id: ο αριθμός(ID) της ομάδας λέξεων-κλειδιών που έχετε δημιουργήσει (αν δεν ορίσετε θα επιστραφεί περιεχόμενο απο όλες τις ομάδες)
id: o αριθμός(ID) μιας συγκεκριμένης αναφοράς (αν δεν ορίσετε θα επιστραφούν ολα τα ID)
posts_number: ο αριθμός των αναφορών που θέλετε να σας επιστραφούν κατα την κλήση στο API (προεπιλεγμένη τιμή = 20 αναφορές)
important: 1 (αν θέλετε μόνο σημαντικές αναφορές)
hasimage: 1 (αν θέλετε μόνο αναφορές με εικόνα)


Παράμετροι επιστροφής (Reponse parameters)
JSON
site: το όνομα της εγκατάστασης σας
datetime: η ημερομηνία της κλήσης
errors: αν 1, τότε υπήρξε κάποιο πρόβλημα (αν κενό τότε δεν υπήρξε πρόβλημα)
message: μήνυμα λάθους ή ο αριθμός των αποτελεσμάτων
id: ο κωδικός της αναφοράς
type: ο τύπος της αναφοράς (article ή video ή social)
source: η διεύθυνση της πηγής της αναφοράς
title: ο τίτλος της αναφοράς
link: η διεύθυνση(url) της αναφοράς
description: το κείμενο της αναφοράς
image: η διευθυνση(url) της φωτογραφίας της αναφοράς (αν υπάρχει)
datetime: η ημερομηνία δημοσίευσης της αναφοράς (σε μορφή YYYY-MM-DD HH:MM:SS)
RSS
channel:title: το όνομα της εγκατάστασης σας
channel:description: η ημερομηνία της κλήσης - μήνυμα λάθους ή ο αριθμός των αποτελεσμάτων
item:title: ο τίτλος της αναφοράς
item:link: η διεύθυνση(url) της αναφοράς
item:description: το κείμενο της αναφοράς
item:enclosure url: η διευθυνση(url) της φωτογραφίας της αναφοράς (αν υπάρχει)
item:pubDate: η ημερομηνία δημοσίευσης της αναφοράς (σε μορφή RFC-822)
item:guid: μοναδικό guid της αναφοράς


Μηνύματα Κατάστασης (Errors)
Αναλόγως του αποτελέσματος της κλήσης σας στο API θα επιστραφούν τα παρακάτω μηνύματα στο πεδίο description (για rss) ή στο πεδίο message (για json)
ERROR: Invalid APIKEY: το apikey που δώσατε δεν είναι έγκυρο ή λείπει
ERROR: API is not enabled for this Site.: To API δεν είναι ενεργοποιημένο για το πακέτο σας
FOUND: X results: Η κλήση έγινε επιτυχώς και αναφέρεται ο αριθμός των αποτελεσμάτων που βρέθηκαν
.


Ενσωμάτωση περιεχομένου σε Wordpress CMS
Εάν το ιστολόγιο ή η ιστοσελίδα σας έχει φτιαχτεί με το Wordpress CMS, μπορείτε να χρησιμοποιήσετε κάποιο απο τα plugin του και να ενσωματώσετε το περιεχόμενο του API έυκολα και γρήγορα.

Τα βήματα που πρέπει να ακολουθήσετε ειναι τα εξής:
1) Θα πρέπει καταρχήν να έχετε ενεργοποιημένο το API και το apikey σας (στη διαχείριση Ρυθμίσεις > Ενσωμάτωση περιεχομένου (API))
2) Κατόπιν αντιγράψτε το API URL σας προσθέτοντας τις παραμέτρους που επιθυμείτε (όπως πχ. αν θέλετε να δώσετε μόνο τις σημαντικές αναφορές ή τις αναφορές με εικόνα). Μην ξεχάσετε οτι πρεπει να ορίσετε τη μορφή περιεχομένου σε rss (παραμετρος output_content=rss)
3) Στη συνέχεια θα πρέπει να εγκαταστήσετε κάποιο απο τα plugin του wordpress που μεταφέρουν δεδομένα μορφής απο RSS πηγές σε Wordpress Posts (άρθρα του Wordpress).
Ενδεικτικά αναφέρουμε το δωρεάν και έυκολο στη χρήση wordpress plugin RSS Post Importer (Περισσότερες πληροφορίες για το plugin μπορείτε να δείτε εδώ εδώ)
Η εγκατάσταση του γίνεται μέσα απο το Wordpress στο Plugins > Add New, συμπληρώστε το rss post importer και κατόπιν πατήστε Εγκατάσταση.
4) Το plugin αφότου εγκατασταθεί και ενεργοποιηθεί επιτυχώς θα το βρείτε στις Ρυθμίσεις > RSS Post Importer
5) Απο εκεί μπορείτε να καταχωρήσετε ώς νέο feed το API URL που δημιουργήσατε στο βήμα 2) και βάση των οδηγιών και των παραμέτρων της παρούσας σελίδας
6) Το RSS Post Importer σας δίνει διάφορες λειτουργίες, μόλις ολοκληρώσετε τις ρυθμίσεις που θέλετε πατήστε --> Save and Import
7) Είστε έτοιμοι, εάν όλα έχουν πάει καλά το περιεχόμενο που επιλέξατε απο το newsgear και το API Θα το βρείτε στα Posts του Wordpress!

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


*Για οποιαδήποτε απορία ή πρόβλημα συναντήσετε, μην διστάσετε να επικοινωνήσετε μαζί μας!