Τεκμηρίωση Mokapen API

Πεδίο εφαρμογής και άδειες

Τα πεδία ελέγχουν ποιους πόρους API μπορεί να διαβάσει ή να γράψει η εφαρμογή σας. Κάθε εύρος έχει ένα επίπεδο πρόσβασης που σχετίζεται με τους ρόλους των μελών του οργανισμού.

Σκούπες Επίπεδο πρόσβασης Περιγραφή Επιτρεπόμενοι ρόλοι
tasks.read Κοινό Read tasks owner, user, member, limited_user, guest, admin
tasks.write Σπόροι Create or update tasks owner, user, admin
projects.read Κοινό Read projects owner, user, member, limited_user, guest, admin
projects.write Σπόροι Create or update projects owner, user, admin
appointments.read Κοινό Read appointments owner, user, member, limited_user, guest, admin
appointments.write Σπόροι Create or update appointments owner, user, admin
bookings.read Κοινό Read bookings owner, user, member, limited_user, guest, admin
bookings.write Σπόροι Create or update bookings owner, user, admin
contacts.read Κοινό Read contact data owner, user, member, limited_user, guest, admin
contacts.write Σπόροι Create or update contacts owner, user, admin
companies.read Κοινό Read company data owner, user, member, limited_user, guest, admin
companies.write Σπόροι Create or update companies owner, user, admin
deals.read Κοινό Read deal data owner, user, member, limited_user, guest, admin
deals.write Σπόροι Create or update deals owner, user, admin
quotes.read Κοινό Read quote data owner, user, member, limited_user, guest, admin
quotes.write Σπόροι Create or update quotes owner, user, admin
orders.read Κοινό Read order data owner, user, member, limited_user, guest, admin
orders.write Σπόροι Create or update orders owner, user, admin
services.read Κοινό Read service data owner, user, member, limited_user, guest, admin
services.write Σπόροι Create or update services owner, user, admin
products.read Κοινό Read product data owner, user, member, limited_user, guest, admin
products.write Σπόροι Create or update products owner, user, admin
tickets.read Κοινό Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Σπόροι Create or update tickets owner, user, admin
documents.read Κοινό Read document data owner, user, member, limited_user, guest, admin
documents.write Σπόροι Create or update documents owner, user, admin
campaigns.read Κοινό Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Σπόροι Create or update campaigns owner, user, admin
profile.write Σπόροι Update profile roles and preferences owner, user, admin
users.write Σπόροι Manage teams and team members owner, user, admin

Πώς λειτουργούν τα πεδία

Στη δημιουργία εφαρμογής, επιλέξτε τα πεδία που μπορεί να ζητήσει. Κατά το χρόνο εκτέλεσης, το διακριτικό πρέπει να περιλαμβάνει το εύρος που απαιτείται από το τελικό σημείο (π.χ. tasks.read για τη λίστα εργασιών).

Για δημόσιες εφαρμογές (τρίτου μέρους), το Mokapen ελέγχει επίσης ότι ο ρόλος του πιστοποιημένου χρήστη στον οργανισμό επιτρέπεται για κάθε επίπεδο εμβέλειας.

  • Public — διαθέσιμο για κάτοχο, διαχειριστή, χρήστη, μέλος, limited_user και επισκέπτη.
  • Ημιπεριορισμένο — διαθέσιμο για ιδιοκτήτη και χρήστη.
  • Περιορισμένο — διαθέσιμο μόνο για κατόχους (περιλαμβάνει profile.write και users.write για προφίλ και διαχείριση ομάδας).

Εύρος αιτήματος

Δημόσιο εφαρμογών: Περάστε τα πεδία ως μια λίστα διαχωρισμένη με κενό χώρο στο URL εξουσιοδότησης OAuth και αίτημα διακριτικού.

Ιδιωτικές εφαρμογές: τα πεδία λαμβάνονται από τη διαμόρφωση της εφαρμογής κατά τη δημιουργία διακριτικών.

scope=tasks.read tasks.γράψτε επαφές.read company.read

Χρειάζεστε βοήθεια;