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

Οργανώσεις

Τα περισσότερα τελικά σημεία Mokapen καλύπτονται από έναν οργανισμό. Το πλαίσιο του οργανισμού ορίζεται τόσο στη διεύθυνση URL όσο και στο διακριτικό πρόσβασης.

Αναγνωριστικό οργανισμού στη διεύθυνση URL

Τα τελικά σημεία στις οντότητες ακολουθούν αυτό το μοτίβο:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Αντικαταστήστε το {org_id} με το αριθμητικό αναγνωριστικό του οργανισμού σας. Ορισμένες ενσωματώσεις ενδέχεται να χρησιμοποιούν ένα κρυπτογραφημένο αναγνωριστικό οργανισμού. το API δέχεται και τις δύο μορφές όπου υποστηρίζονται.

Οργανωτικός περιορισμός στο διακριτικό

Τα διακριτικά που εκδίδονται για εφαρμογές προγραμματιστών περιλαμβάνουν ένα organization_id (αποθηκευμένο στην εγγραφή διακριτικού και υπάρχει στην απάντηση OAuth).

Όταν καλείτε ένα τελικό σημείο με {org_id} στη διεύθυνση URL, το Mokapen επαληθεύει ότι το διακριτικό είναι εξουσιοδοτημένο για αυτόν τον οργανισμό. Εάν ο οργανισμός στη διεύθυνση URL δεν ταιριάζει με τον οργανισμό στο διακριτικό, το API απαντά 403 Forbidden.

  • Ιδιωτικές εφαρμογές — ο οργανισμός ρυθμίζεται αυτόματα στη δημιουργία διακριτικών (με βάση την ενεργή οργάνωση στον πίνακα ελέγχου προγραμματιστή).
  • App public — ο τελικός χρήστης επιλέγει τον οργανισμό κατά τη συναίνεση του OAuth.

Καταληκτικό σημείο της λίστας οργανισμών

Για να αποκτήσετε πρόσβαση σε οργανισμούς από τον χρήστη ή την επαληθευμένη ενσωμάτωση:

GET /api/v1/organizations

Premium οργάνωση και πρόσβαση στο API

Η διαθεσιμότητα API και τα ημερήσια ποσοστά εξαρτώνται από το σχέδιο Mokapen του οργανισμού σας. Δείτε Όρια API για όρια ανά πρόγραμμα.

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