github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
8.1 KiB
Plaintext
131 lines
8.1 KiB
Plaintext
---
|
|
title: Επισκόπηση API
|
|
info: Κατανοήστε τα τέσσερα διαφορετικά API και πότε να χρησιμοποιείτε το καθένα.
|
|
image: /images/user-guide/api/api-overview.png
|
|
sectionInfo: Μάθετε πώς να συνδέσετε το Twenty με τα άλλα σας εργαλεία.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Το Twenty έχει σχεδιαστεί ώστε να είναι φιλικό προς προγραμματιστές, προσφέροντας ισχυρά API που προσαρμόζονται στο προσαρμοσμένο μοντέλο δεδομένων σας. Παρέχουμε τέσσερα διακεκριμένα είδη API για να καλύψουμε διαφορετικές ανάγκες ενσωμάτωσης.
|
|
|
|
## Προσέγγιση προτεραιότητας για προγραμματιστές
|
|
|
|
Το Twenty δημιουργεί API ειδικά για το μοντέλο δεδομένων σας, που σημαίνει:
|
|
|
|
- **Δεν απαιτούνται μακροί αναγνωριστικοί αριθμοί**: Χρησιμοποιήστε τα ονόματα αντικειμένων και πεδίων απευθείας σε endpoints
|
|
- **Τυπικά και προσαρμοσμένα αντικείμενα αντιμετωπίζονται ισότιμα**: Τα προσαρμοσμένα αντικείμενά σας λαμβάνουν την ίδια αντιμετώπιση API με τα ενσωματωμένα
|
|
- **Αποκλειστικοί endpoints**: Κάθε αντικείμενο και πεδίο παίρνει το δικό του API endpoint
|
|
- **Προσαρμοσμένη τεκμηρίωση**: Δημιουργείται ειδικά για το μοντέλο δεδομένων του workspace σας
|
|
|
|
<Warning>
|
|
Το προσαρμοσμένο API σας δημιουργεί εξατομικευμένη τεκμηρίωση προσβάσιμη μέσω Ρυθμίσεις → API & Webhooks μετά τη δημιουργία ενός API key. Αυτή η τεκμηρίωση αντικατοπτρίζει το ακριβές μοντέλο δεδομένων και τις διαμορφώσεις πεδίων σας.
|
|
</Warning>
|
|
|
|
## Οι Τέσσερις Τύποι API
|
|
|
|
Το Twenty προσφέρει API σε μορφές **REST** και **GraphQL**:
|
|
|
|
### REST APIs
|
|
|
|
#### 1. REST Metadata API
|
|
|
|
- **Σκοπός**: Διαχειριστείτε τη δομή του workspace και το μοντέλο δεδομένων σας
|
|
- **Περιπτώσεις χρήσης**:
|
|
- Δημιουργία, τροποποίηση ή διαγραφή αντικειμένων και πεδίων
|
|
- Διαμόρφωση ρυθμίσεων workspace
|
|
- Διαχείριση σχέσεων μοντέλου δεδομένων
|
|
- **Πρόσβαση**: Διαθέσιμο μέσω endpoints REST
|
|
|
|
#### 2. REST Core API
|
|
|
|
- **Σκοπός**: Διαχειριστείτε τα πραγματικά αρχεία δεδομένων σας
|
|
- **Περιπτώσεις χρήσης**:
|
|
- Δημιουργία, ανάγνωση, ενημέρωση, διαγραφή εγγραφών
|
|
- Ερώτηση συγκεκριμένων δεδομένων
|
|
- Διαχείριση σχέσεων εγγραφών
|
|
- **Πρόσβαση**: Διαθέσιμο μέσω endpoints REST
|
|
|
|
### GraphQL APIs
|
|
|
|
#### 3. GraphQL Metadata API
|
|
|
|
- **Σκοπός**: Ίδιος με το REST Metadata API αλλά με οφέλη GraphQL
|
|
- **Περιπτώσεις χρήσης**: Ίδια διαχείριση workspace και μοντέλου δεδομένων
|
|
- **Επιπλέον οφέλη**:
|
|
- Αναζήτηση πολλαπλών τύπων μεταδεδομένων σε ένα αίτημα
|
|
- Ακριβής επιλογή πεδίων
|
|
- Καλύτερη απόδοση για σύνθετα ερωτήματα
|
|
|
|
#### 4. GraphQL Core API
|
|
|
|
- **Σκοπός**: Ίδιος με το REST Core API αλλά με πλεονεκτήματα GraphQL
|
|
- **Περιπτώσεις χρήσης**: Ίδια διαχείριση αρχείων δεδομένων
|
|
- **Επιπλέον οφέλη**:
|
|
- **Ομαδικές λειτουργίες**: Διαθέσιμο για όλες τις λειτουργίες
|
|
- **Εισαγωγή ή ενημέρωση αρχείων**: Δημιουργία ή ενημέρωση αρχείων σε μία κλήση
|
|
- Αναζήτηση σχέσεων σε ένα μόνο αίτημα
|
|
- Ακριβής ανάκτηση δεδομένων
|
|
|
|
## Ομαδικές Λειτουργίες
|
|
|
|
### Υποστήριξη Ομαδικών Λειτουργιών REST και GraphQL
|
|
|
|
Και τα REST και GraphQL API υποστηρίζουν ομαδικές λειτουργίες για τις περισσότερες ενέργειες:
|
|
|
|
- **Μέγεθος ομάδας**: Έως 60 εγγραφές ανά αίτημα
|
|
- **Διαθέσιμες λειτουργίες**: Δημιουργία, ενημέρωση, διαγραφή πολλαπλών εγγραφών
|
|
- **Απόδοση**: Σημαντικά ταχύτερο από τις μεμονωμένες κλήσεις API
|
|
|
|
### Χαρακτηριστικά μόνο για GraphQL
|
|
|
|
- **Ομαδική εισαγωγή**: Διαθέσιμο μόνο σε GraphQL API
|
|
- **Χρήση**: Χρησιμοποιήστε πληθυντικούς στα ονόματα αντικειμένων (π.χ., `CreateCompanies` αντί για `CreateCompany`)
|
|
- **Απαίτηση**: Αυτός είναι ο λόγος γιατί τα ονόματα αντικειμένων στον ενικό και πληθυντικό πρέπει να είναι διαφορετικά
|
|
|
|
## Πρόσβαση στην Τεκμηρίωση API
|
|
|
|
1. Μεταβείτε στις **Ρυθμίσεις → API & Webhooks**
|
|
2. Δημιουργήστε ένα API key (απαιτείται για πρόσβαση στην τεκμηρίωση)
|
|
3. Πρόσβαση στην προσαρμοσμένη τεκμηρίωση και στο playground σας
|
|
4. Ελέγξτε τα API με το πραγματικό σας μοντέλο δεδομένων
|
|
|
|
Η τεκμηρίωσή σας είναι μοναδική για το workspace σας γιατί αντικατοπτρίζει τα προσαρμοσμένα αντικείμενα, πεδία και σχέσεις σας.
|
|
|
|
## Πότε να χρησιμοποιήσετε κάθε API
|
|
|
|
### Χρησιμοποιήστε Metadata API όταν:
|
|
|
|
- Ρυθμίζετε το μοντέλο δεδομένων σας
|
|
- Δημιουργείτε προσαρμοσμένα αντικείμενα ή πεδία
|
|
- Διαμορφώνετε ρυθμίσεις workspace
|
|
|
|
### Χρησιμοποιήστε Core API όταν:
|
|
|
|
- Διαχειρίζεστε καθημερινά δεδομένα (Άνθρωποι, Εταιρείες, Ευκαιρίες)
|
|
- Ενσωματώνετε με εξωτερικά συστήματα
|
|
- Κατασκευάζετε προσαρμοσμένες εφαρμογές
|
|
- Αυτοματοποιείτε ροές δεδομένων
|
|
|
|
### Επιλέξτε GraphQL όταν:
|
|
|
|
- Χρειάζεστε ομαδικές λειτουργίες
|
|
- Θέλετε να ελαχιστοποιήσετε τις κλήσεις API
|
|
- Χρειάζεστε λειτουργικότητα εισαγωγής-ενημέρωσης
|
|
- Κατασκευάζετε σύνθετες ενσωματώσεις
|
|
|
|
### Επιλέξτε REST όταν:
|
|
|
|
- Προτιμάτε απλούστερη δομή API
|
|
- Κατασκευάζετε βασικές ενσωματώσεις
|
|
- Η ομάδα σας είναι πιο εξοικειωμένη με το REST
|
|
- Χρειάζεστε άμεσες λειτουργίες CRUD
|
|
|
|
## Επόμενα Βήματα
|
|
|
|
- **[Ρυθμίσεις API & Webhooks](/l/el/user-guide/integrations-api/api-webhooks)**: Μάθετε πώς να δημιουργείτε κλειδιά API και webhooks
|
|
- **Προσαρμοσμένη Τεκμηρίωση**: Πρόσβαση στην εξατομικευμένη τεκμηρίωση API μέσω Ρυθμίσεις → API & Webhooks
|
|
|