Μετάβαση στο κύριο περιεχόμενο

Integrations API

Η σελίδα Ενσωματώσεις στον πίνακα ελέγχου δείχνει μια κατάσταση σε κάθε κάρτα (WhatsApp, Delivyr, οι διαφημιστικές πλατφόρμες, τα καταστήματα, οι αποθήκες δεδομένων και τα εργαλεία ανάλυσης). Αυτό το endpoint επιστρέφει την ίδια κατάσταση, ώστε ένα script ή μια εργασία παρακολούθησης να ελέγχει ότι ένα workspace είναι ακόμη συνδεδεμένο χωρίς να ανοίξει τον πίνακα ελέγχου.

Η σύνδεση και η αποσύνδεση γίνονται στον πίνακα ελέγχου. Αυτό το API είναι μόνο για ανάγνωση.

Όλα τα endpoints αυτής της σελίδας είναι σχετικά με το βασικό URL: https://api-eu1.joryio.com/api - δείτε την Επισκόπηση API.

Αυθεντικοποίηση​

Χρησιμοποιήστε ένα κλειδί API ως bearer token (ή μια σύνδεση στον πίνακα ελέγχου). Το κλειδί χρειάζεται το δικαίωμα integrations:read. Ένα κλειδί ανήκει σε ένα workspace και η απάντηση αφορά αυτό το workspace.

Authorization: Bearer jry_live_xxxxxxxxxxxxxxxxxxxx

Λήψη της κατάστασης κάθε ενσωμάτωσης​

GET /integrations-hub/status

Χωρίς παραμέτρους. Η απάντηση περιέχει κάθε ενσωμάτωση της σελίδας Ενσωματώσεις, με τη σειρά της σελίδας:

{
"integrations": [
{ "id": "whatsapp", "status": "connected", "connected": true },
{ "id": "delivyr", "status": "not_connected", "connected": false, "count": 0 },
{ "id": "meta_ads", "status": "error", "connected": true, "count": 2 },
{ "id": "shopify", "status": "connected", "connected": true, "count": 1 },
{ "id": "snowflake", "status": "connected", "connected": true, "count": 1 },
{ "id": "segment", "status": "coming_soon", "connected": false }
]
}
ΠεδίοΤύποςΣημασία
idstringΗ ενσωμάτωση: whatsapp, delivyr, meta_ads, google_ads, tiktok_ads, linkedin_ads, criteo_ads, shopify, woocommerce, magento, prestashop, snowflake, bigquery, s3, redshift, amplitude, mixpanel, segment. Νέες ενσωματώσεις προστίθενται με τον καιρό - αγνοήστε ένα id που δεν γνωρίζετε.
statusstringΤι δείχνει η κάρτα - δείτε τις Τιμές κατάστασης.
connectedbooleantrue όταν τουλάχιστον μία σύνδεση πίσω από την ενσωμάτωση είναι ενεργή. Ένα κατάστημα του οποίου ο τελευταίος συγχρονισμός απέτυχε παραμένει συνδεδεμένο (status είναι error, connected είναι true).
countnumberΠόσοι συνδεδεμένοι λογαριασμοί, ροές δεδομένων ή καταστήματα βρίσκονται πίσω από την ενσωμάτωση. Δεν υπάρχει για το WhatsApp ή για μια ενσωμάτωση που δεν είναι ακόμη διαθέσιμη.

Τιμές κατάστασης​

statusΣημασία
connectedΣυνδεδεμένο και λειτουργεί.
not_connectedΔεν έχει συνδεθεί τίποτα ακόμη.
action_neededΜόνο WhatsApp: προστέθηκε ένας λογαριασμός και περιμένει έγκριση.
errorΣυνδεδεμένο, αλλά κάτι χρειάζεται προσοχή: ένας λογαριασμός διαφημιστικής πλατφόρμας αναφέρει σφάλμα ή ο τελευταίος συγχρονισμός ενός καταστήματος απέτυχε. Ανοίξτε την ενσωμάτωση στον πίνακα ελέγχου για να δείτε τι απέτυχε.
coming_soonΗ ενσωμάτωση δεν είναι ακόμη διαθέσιμη.

Όταν μια ενσωμάτωση έχει περισσότερα από ένα μέρη (για παράδειγμα το Snowflake: εισαγωγή δεδομένων και ροή συμβάντων), ένα error σε οποιοδήποτε μέρος υπερισχύει, μετά το connected και μετά το action_needed.

Τι μετράει ως συνδεδεμένο​

  • WhatsApp: ένας ενεργός λογαριασμός WhatsApp Business του workspace ή ολόκληρου του οργανισμού, ή ένας ενεργός πάροχος WhatsApp που έχει ρυθμίσει η Joryio.
  • Καταστήματα (Shopify, WooCommerce, Magento, PrestaShop): μια σύνδεση καταστήματος που δεν έχει αποσυνδεθεί.
  • Delivyr: ένας λογαριασμός Delivyr συνδεδεμένος με το workspace.
  • Διαφημιστικές πλατφόρμες και εισαγωγές από αποθήκες δεδομένων: ένας συνδεδεμένος λογαριασμός. Κάθε λογαριασμός μετράει μία φορά.
  • Ροές δεδομένων (S3, BigQuery, Snowflake, Redshift, Amplitude, Mixpanel): μια ροή δεδομένων προς αυτόν τον προορισμό.

Αυτοί είναι οι ίδιοι κανόνες που χρησιμοποιεί η Joryio παντού όπου αναφέρει συνδεδεμένα κανάλια και καταστήματα.

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

Σφάλματα​

ΚατάστασηΠότε
401Το κλειδί API λείπει ή δεν είναι έγκυρο.
403Το κλειδί δεν έχει το integrations:read.
400Μια σύνδεση στον πίνακα ελέγχου χωρίς επιλεγμένο workspace.
429Πάρα πολλά αιτήματα - δείτε τα Όρια ρυθμού.

Παράδειγμα​

curl https://api-eu1.joryio.com/api/integrations-hub/status \
-H "Authorization: Bearer jry_live_xxxxxxxxxxxxxxxxxxxx"