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

Για να ξεκινήσετε

Πριν καλέσετε οποιοδήποτε τελικό σημείο API, δημιουργήστε και διαμορφώστε μια εφαρμογή στον λογαριασμό προγραμματιστή Mokapen.

Επισκόπηση

Τα API Mokapen είναι REST. Κάθε αίτημα πρέπει να περιλαμβάνει μια έγκυρη κεφαλίδα Authorization: Bearer , εκτός εάν αναφέρεται διαφορετικά.

URL βάσης: https://mokapen.com/api

Πρόθεμα έκδοσης API: v1 (παράδειγμα: /api/v1/{org_id}/contacts).

Βήμα 1 — Δημιουργήστε μια εφαρμογή

Συνδεθείτε στο Mokapen, ανοίξτε τον οργανισμό σας και μεταβείτε στο Λογαριασμός → Προγραμματιστής → Οι εφαρμογές μου. Από εκεί μπορείτε να δείτε υπάρχουσες εφαρμογές ή να δημιουργήσετε μια νέα.

Το Mokapen υποστηρίζει δύο τύπους εφαρμογών:

  • App public — σχεδιασμένο για ενσωματώσεις που χρησιμοποιούνται από πολλούς χρήστες Mokapen. Χρησιμοποιήστε τη ροή κώδικα εξουσιοδότησης OAuth 2.0. Οι χρήστες εξουσιοδοτούν την εφαρμογή σας και επιλέγουν σε ποιον οργανισμό θα παραχωρήσουν πρόσβαση.
  • Ιδιωτικές εφαρμογές — σχεδιασμένες για εσωτερικό αυτοματισμό στον οργανισμό σας. Χρησιμοποιήστε την επιχορήγηση client_credentials. Τα διακριτικά δημιουργούνται από τον πίνακα ελέγχου προγραμματιστή χωρίς ανακατευθύνσεις OAuth στον τελικό χρήστη.

Απαιτήσεις εφαρμογής

Πεδίο Εφαρμογή δημόσια Ιδιωτικές εφαρμογές
Επωνυμία εταιρείας Υποχρεωτικός Υποχρεωτικός
Ιστοσελίδα της εταιρείας Υποχρεωτικός Υποχρεωτικός
Όνομα εφαρμογής Υποχρεωτικός Υποχρεωτικός
Λογότυπο εταιρείας Υποχρεωτικός Υποχρεωτικός
Διευθύνσεις URL ανακατεύθυνσης Υποχρεωτικός Δεν απαιτείται
Αφιερωμένος χρήστης Δεν απαιτείται Υποχρεωτικός
Ενδιαφερόμενα μέρη Προαιρετικός Προαιρετικός
Για ιδιωτικές εφαρμογές, το πεδίο Dedicated User ορίζει ποιο μέλος οργανισμού αντιπροσωπεύει η ενοποίηση. Η πρόσβαση API σέβεται τα δικαιώματα και το πεδίο εφαρμογής του συγκεκριμένου χρήστη.

Βήμα 2 — Επιλέξτε πεδία API

Αφού συμπληρώσετε τα δεδομένα της εφαρμογής, κάντε κλικ στο Continue για να επιλέξετε τα απαραίτητα πεδία (δικαιώματα) και, στη συνέχεια, αποθηκεύστε την εφαρμογή.

Μόνο τα πεδία που ενεργοποιήθηκαν κατά τη ρύθμιση μπορούν να ζητηθούν στην εξουσιοδότηση (δημόσια εφαρμογή) ή να συμπεριληφθούν σε διακριτικά (ιδιωτική εφαρμογή).

Βήμα 3 — Ενεργοποίηση και διαπιστευτήρια

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

Οι αιτήσεις δημόσιες ξεκινούν ως Εκκρεμεί έγκριση. Το Mokapen εξετάζει τα απαιτούμενα πεδία προτού ενεργοποιήσει την εφαρμογή. Όταν η κατάσταση είναι Active, ανοίξτε την καρτέλα Credentials για να λάβετε client_id και client_secret⟦T11 τον κωδικό εξουσιοδότησης ⟦T11.

Εάν αλλάξετε εύρος σε μια ήδη ενεργή δημόσια εφαρμογή, θα επιστρέψει στην αναμονή έγκρισης και τα υπάρχοντα διακριτικά ανακαλούνται.

Αποθηκεύστε τα διαπιστευτήριά σας με ασφάλεια. Ποτέ μην αποκαλύπτετε το μυστικό του πελάτη σε κώδικα από την πλευρά του πελάτη ή σε δημόσια αποθετήρια.

Επόμενα βήματα

Ξεκινήστε να εργάζεστε εξοικονομώντας χρόνο.

ή
Κάντε κράτηση για ένα demo

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