REST API

Έλεγχος ταυτότητας

Επιλέξτε προσωπικό κλειδί API ή OAuth 2.1 με PKCE.

Χρησιμοποιήστε ένα προσωπικό κλειδί API για τα δικά σας script. Χρησιμοποιήστε OAuth για εφαρμογή που ενεργεί για άλλους πελάτες NinjaBuy, συμπεριλαμβανομένων των πελατών MCP.

OAuth 2.1

Χρησιμοποιήστε τη ροή κωδικού εξουσιοδότησης με PKCE S256. Το REST και το MCP δέχονται το ίδιο διακριτικό πρόσβασης OAuth του NinjaBuy. Κάθε διακριτικό ενεργεί για τον λογαριασμό που συνδέθηκε και ενέκρινε την πρόσβαση· δεν μπορείτε να επιλέξετε άλλον λογαριασμό στο σώμα του αιτήματος.

Όλα τα τελικά σημεία OAuth χρησιμοποιούν την προέλευση https://www.ninjabuy.com. Διαδρομές εντοπισμού και εξουσιοδότησης:

Εντοπισμός OAuth · Εντοπισμός πόρου MCP

POST /api/auth/mcp/register
GET  /api/auth/mcp/authorize
POST /api/auth/mcp/token
  1. Καταχωρίστε τον πελάτη σας στο POST /api/auth/mcp/register. Ένας δημόσιος πελάτης στέλνει JSON με client_name, redirect_uris και token_endpoint_auth_method: "none". Κρατήστε το client_id που επιστρέφεται.
  2. Δημιουργήστε νέα τυχαία state και PKCE code_verifier. Υπολογίστε το SHA-256 code_challenge κωδικοποιημένο σε base64url.
  3. Ανοίξτε το /api/auth/mcp/authorize στο πρόγραμμα περιήγησης του χρήστη με response_type=code, client_id, redirect_uri, state, code_challenge, code_challenge_method=S256 και scope=openid offline_access.
  4. Ο χρήστης συνδέεται με τον αριθμό τηλεφώνου του στο NinjaBuy και εγκρίνει την εφαρμογή σας. Στο callback σας, επαληθεύστε το state πριν χρησιμοποιήσετε το code που επιστράφηκε.
  5. Στείλτε POST με κωδικοποίηση φόρμας στο /api/auth/mcp/token με grant_type=authorization_code, code, client_id, το ίδιο redirect_uri και code_verifier.

Στείλτε το διακριτικό πρόσβασης που προκύπτει στα αιτήματα REST:

Authorization: Bearer YOUR_ACCESS_TOKEN

Τα διακριτικά πρόσβασης διαρκούν 1 ώρα. Με το offline_access, τα διακριτικά ανανέωσης επιτρέπουν ανανέωση για έως 7 ημέρες. Ανανεώστε μέσω του ίδιου endpoint με POST με κωδικοποίηση φόρμας και grant_type=refresh_token, client_id και refresh_token. Αποθηκεύστε τα διακριτικά με ασφάλεια και συνδεθείτε ξανά όταν η ανανέωση δεν είναι πλέον έγκυρη.

Ένα απόν, ληγμένο ή μη έγκυρο διακριτικό πρόσβασης επιστρέφει 401 με πρόκληση ανακάλυψης WWW-Authenticate. Δείτε τα Σφάλματα.

Σε αυτή τη σελίδα