Αναφορά API για προγραμματιστές

Συνδέστε τη δική σας εφαρμογή με τον χώρο εργασίας σας: το REST API, τα κλειδιά και οι εμβέλειές του, τα σφάλματα, τα όρια ρυθμού και τα webhooks.

Πού θα το βρείτε

⚙️ Ρυθμίσεις › Αναφορά API · Αρχική σελίδα › Πόροι › Αναφορά API

Άνοιγμα αυτής της οθόνης
Η αναφορά API με το πλαϊνό μενού, την πιστοποίηση και τα τελικά σημεία.

Βήματα

  1. Ανοίξτε το «Αναφορά API» στην πλαϊνή γραμμή ή το «Αναφορά API» στο μενού «Πόροι» της αρχικής σελίδας.
  2. Ξεκινήστε με το «Ξεκινήστε εδώ»: «Βασικό URL και συμβάσεις», «Πιστοποίηση» και «Εμβέλειες».
  3. Αναζητήστε «Τελικά σημεία» ανά ομάδα· καθένα δείχνει τις παραμέτρους, το σώμα του αιτήματος, την απάντηση και τα σφάλματά του με παραδείγματα.
  4. Διαβάστε τα «Σφάλματα και κωδικοί κατάστασης», «Όρια ρυθμού» και «Webhooks (εξερχόμενα)» πριν βγείτε σε παραγωγή. Το «OpenAPI JSON» κατεβάζει ολόκληρη την προδιαγραφή.

Αντιμετώπιση προβλημάτων

Πώς παίρνω κλειδί API;

Τα κλειδιά εκδίδονται για τον χώρο εργασίας σας κατόπιν αιτήματος· δεν μπορούν ακόμη να δημιουργηθούν μέσα στην εφαρμογή. Τα κλειδιά του χώρου εργασίας σας παρατίθενται στη σελίδα προγραμματιστών της περιοχής ΤΝ, όπου όσοι διαχειρίζονται τον χώρο εργασίας μπορούν επίσης να προσθέσουν και να δοκιμάσουν τελικά σημεία webhook.

Συμβουλές

  • Καλείτε το API μόνο από τον διακομιστή σας. Μην βάζετε ποτέ κλειδί σε ιστοσελίδα ή σε εφαρμογή κινητού.

Καλό να γνωρίζετε

  • Η αναφορά API διαβάζεται χωρίς σύνδεση.

Σχετικοί οδηγοί

Ξεκινήστε δωρεάν Αρχική