8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
6.4 KiB
Plaintext
56 lines
6.4 KiB
Plaintext
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: Ανακαλύψτε πώς να χρησιμοποιείτε τα APIs μας.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Επισκόπηση
|
||
|
||
Το Twenty API επιτρέπει στους προγραμματιστές να αλληλεπιδρούν προγραμματικά με την πλατφόρμα Twenty CRM. Χρησιμοποιώντας το API, μπορείτε να ενσωματώσετε το Twenty με άλλα συστήματα, να αυτοματοποιήσετε τον συγχρονισμό δεδομένων και να δημιουργήσετε προσαρμοσμένες λύσεις γύρω από τα δεδομένα πελατών σας. Το API παρέχει σημεία τερματισμού για **δημιουργία, ανάγνωση, ενημέρωση και διαγραφή** βασικών αντικειμένων CRM (όπως άτομα και εταιρείες) καθώς και πρόσβαση σε ρυθμίσεις μεταδεδομένων.
|
||
|
||
**API Playground:** Μπορείτε τώρα να αποκτήσετε πρόσβαση στο API Playground μέσα από τις ρυθμίσεις της εφαρμογής. Για να δοκιμάσετε τις κλήσεις API σε πραγματικό χρόνο, συνδεθείτε στο χώρο εργασίας σας στο Twenty και πλοηγηθείτε στις **Ρυθμίσεις → APIs & Webhooks**. Αυτό ανοίγει το ενσωματωμένο API Playground και τις ρυθμίσεις για τα κλειδιά API.
|
||
**[Πηγαίνετε στις Ρυθμίσεις API](https://app.twenty.com/settings)**
|
||
|
||
## Ταυτοποίηση
|
||
|
||
Το API του Twenty χρησιμοποιεί κλειδιά API για πιστοποίηση. Κάθε αίτηση προς προστατευμένα σημεία τερματισμού πρέπει να περιλαμβάνει ένα κλειδί API στην κεφαλίδα.
|
||
|
||
- **Κλειδιά API:** Μπορείτε να δημιουργήσετε ένα νέο κλειδί API από τη σελίδα **Ρυθμίσεις API** της εφαρμογής σας Twenty. Κάθε κλειδί API είναι ένα μυστικό διακριτικό που παρέχει πρόσβαση στα δεδομένα σας CRM, οπότε κρατήστε το ασφαλές. Εάν ένα κλειδί έχει υπονομευθεί, ανακαλέστε το από τις ρυθμίσεις και δημιουργήστε ένα νέο.
|
||
- **Κεφαλίδα Εξουσιοδότησης:** Μόλις έχετε ένα κλειδί API, συμπεριλάβετε το στην κεφαλίδα `Authorization` των αιτημάτων σας HTTP. Χρησιμοποιήστε το σχήμα διακριτικού Bearer. Για παράδειγμα:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Αντικαταστήστε το `YOUR_API_KEY` με το κλειδί που έχετε. Αυτή η κεφαλίδα πρέπει να υπάρχει σε **όλα τα αιτήματα API**. Αν το διακριτικό λείπει ή είναι άκυρο, το API θα απαντήσει με ένα σφάλμα πιστοποίησης (HTTP 401 Unauthorized).
|
||
|
||
## Σημεία τερματισμού API
|
||
|
||
Όλοι οι πόροι μπορούν να προσπελαστούν μέσω REST ή GraphQL.
|
||
|
||
- **Cloud:** `https://api.twenty.com/` ή το δικό σας προσαρμοσμένο όνομα τομέα / υποτομέα
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
Τα σημεία τερματισμού ομαδοποιούνται σε δύο κατηγορίες: **Core API** και **Metadata API**. Το **Core API** χειρίζεται τα κύρια δεδομένα CRM (π.χ. άτομα, εταιρείες, σημειώσεις, εργασίες), ενώ το **Metadata API** περιλαμβάνει δεδομένα ρυθμίσεων (όπως προσαρμοσμένα πεδία ή ορισμούς αντικειμένων). Οι περισσότερες ενσωματώσεις θα χρησιμοποιούν κυρίως το Core API.
|
||
|
||
### Core API
|
||
|
||
Προσβάσιμο στο `/rest/` ή `/graphql/`.
|
||
Το **Core API** λειτουργεί ως ενιαία διεπαφή για τη διαχείριση βασικών οντοτήτων CRM (άτομα, εταιρείες, σημειώσεις, εργασίες) και των σχέσεών τους, προσφέροντας **τόσο REST όσο και GraphQL** μοντέλα αλληλεπίδρασης.
|
||
|
||
### Metadata API
|
||
|
||
Προσβάσιμο στο `/rest/metadata/` ή `/metadata/`.
|
||
Τα σημεία τερματισμού του Metadata API σας επιτρέπουν να λαμβάνετε πληροφορίες σχετικά με το σχήμα και τις ρυθμίσεις σας. Για παράδειγμα, μπορείτε να ανακτήσετε ορισμούς προσαρμοσμένων πεδίων, σχήματα αντικειμένων, κ.λπ.
|
||
|
||
- **Παραδείγματα Σημείων Τερματισμού:**
|
||
|
||
- `GET /rest/metadata/objects` – Λίστα όλων των τύπων αντικειμένων και των μεταδεδομένων τους (πεδία, σχέσεις).
|
||
- `GET /rest/metadata/objects/{objectName}` – Λάβετε μεταδεδομένα για ένα συγκεκριμένο αντικείμενο (π.χ., `άτομα`, `εταιρείες`).
|
||
- `GET /rest/metadata/picklists` – Λάβετε επιλογές πεδίων picklist (αναδυόμενα μενού) που ορίζονται στο CRM.
|
||
|
||
Συνήθως, τα σημεία τερματισμού μεταδεδομένων χρησιμοποιούνται για να κατανοήσουν τη δομή δεδομένων (για δυναμικές ενσωματώσεις ή δημιουργία φορμών) παρά για να διαχειριστούν πραγματικά αρχεία. Είναι κυρίως ανάγνωσης μόνο στις περισσότερες περιπτώσεις. Απαιτείται πιστοποίηση και για αυτά (χρησιμοποιήστε το κλειδί API σας). |