API

Εξουσιοδότηση

Κάθε αίτημα προς το CRM API μεταδίδει κεφαλίδες εξουσιοδότησης. Ποιες κεφαλίδες απαιτούνται για τη μέθοδο, αναφέρεται στη σελίδα της στη ενότητα «Εξουσιοδότηση».

Οι ενσωματώσεις εξουσιοδοτούνται με API-διακριτικό στην κεφαλίδα Authorization. Το διακριτικό πρόσβασης token-access εκδίδεται κατά τη σύνδεση μέσω API και είναι κατάλληλο για εφαρμογές που λειτουργούν εκ μέρους του χρήστη.

Κεφαλίδες

api-token

Κεφαλίδα: Authorization · Μορφή: fs_api_* · Χρησιμοποιείται σε μεθόδους: 365

API-διακριτικό από την ενότητα api_tokens. Η τιμή της κεφαλίδας Authorization είναι Bearer <διακριτικό>. Διακριτικό συνεργάτη: αν κατά την έκδοση του διακριτικού έχει επιλεγεί αλυσίδα, λειτουργεί μόνο με αυτήν την αλυσίδα και η κεφαλίδα chain δεν απαιτείται. Αν δεν έχει επιλεγεί αλυσίδα, το διακριτικό έχει πρόσβαση σε όλες τις αλυσίδες του λογαριασμού, αλλά δεν έχει ενεργή αλυσίδα. Κάθε αίτημα που απαιτεί αλυσίδα πρέπει να περιλαμβάνει την κεφαλίδα chain, διαφορετικά επιστρέφεται σφάλμα 117 με field: chain. Το /chains επιστρέφει τις αλυσίδες του λογαριασμού· το /chains.switch δεν είναι διαθέσιμο για το διακριτικό (σφάλμα 268).

Παράδειγμα

Authorization: Bearer fs_api_YOUR_TOKEN

language

Κεφαλίδα: language · Χρησιμοποιείται σε μεθόδους: 374

Γλώσσα απάντησης — κωδικός ISO 639-1, π.χ. ru

Παράδειγμα

language: el

role

Κεφαλίδα: role · Χρησιμοποιείται σε μεθόδους: 374

Ρόλος χρήστη: partner ή affiliate

Παράδειγμα

role: partner

chain

Κεφαλίδα: chain · Χρησιμοποιείται σε μεθόδους: 0

Το δίκτυο στο οποίο εκτελείται το αίτημα. Απαιτείται μόνο για το διακριτικό συνεργάτη που εκδίδεται χωρίς επιλογή δικτύου· σε άλλες περιπτώσεις αγνοείται

Παράδειγμα

chain: YOUR_TOKEN

Σύνολα κεφαλίδων

Η μέθοδος δέχεται ένα από τα σύνολα. Τα σύνολα με API-token είναι κατάλληλα για ενσωματώσεις.

api-token + language + roleμέθοδοι: 365
language + roleμέθοδοι: 9

Σφάλματα πρόσβασης

Ένα μη έγκυρο, μπλοκαρισμένο ή ληγμένο διακριτικό, καθώς και ένα αίτημα χωρίς την απαραίτητη κεφαλίδα, επιστρέφει σφάλμα με κωδικό. Οι τιμές των κωδικών βρίσκονται στην ενότητα «Σφάλματα».

Σφάλματα →