תיעוד Nodaroמפתחים
בנו על Nodaro עם ה-REST API, עם ה-SDK ל-TypeScript ועם ה-CLI. השתמשו באסימוני API או ב-OAuth, צרו לקוחות מ-OpenAPI וחברו סוכני AI דרך MCP.
Nodaro בנוי בגישת REST-first: העורך של Nodaro, ה-SDK ל-TypeScript וה-CLI מדברים כולם עם אותו HTTP API, ולכן כל מה שעושים ב-Nodaro אפשר לעשות גם באופן אוטומטי, עם אסימון Bearer ובקשת JSON. החלק הזה בתיעוד מתאר את ה-API, את הלקוחות שלו, את דרכי האימות ואת הדרכים לשלב את Nodaro במוצר שלכם. עוזרי AI מגיעים לאותם תהליכים ומודלים דרך שרת ה-MCP.
שלוש דרכי גישה
| ממשק | התקנה | למה להשתמש בו |
|---|---|---|
| REST API | אין צורך: שולחים בקשות HTTPS אל https://app.nodaro.ai/v1/ | כל שפה, כל פלטפורמה |
| SDK ל-TypeScript | npm install @nodaro/sdk | קוד עם טיפוסים ב-Node, בדפדפנים, ב-React Native ובסביבות ריצה בקצה |
| CLI | npm install -g @nodaro/cli, או קובץ בינארי עצמאי | טרמינלים, משימות cron ופייפליינים של CI |
ה-SDK משתמש ב-fetch וב-URL, ולכן הוא רץ על Node.js 20 ומעלה, בדפדפנים, ב-React Native וגם על Cloudflare Workers, Deno ו-Bun. ה-CLI הוא מעטפת דקה סביב ה-SDK: כל מה שה-CLI עושה, גם ה-SDK עושה.
אותה קריאה בכל אחד מהם, להרצת תהליך שמור:
curl -s -X POST https://app.nodaro.ai/v1/workflows/8c2d7f1e-3a4b-4c5d-9e6f-7a8b9c0d1e2f/run \
-H "Authorization: Bearer $NODARO_API_KEY"
# {"executionId":"3f9e2b1a-…","status":"pending"}import { createClient, StaticTokenAuth } from '@nodaro/sdk'
const client = createClient({
baseUrl: 'https://app.nodaro.ai',
auth: new StaticTokenAuth(process.env.NODARO_API_KEY!),
})
const { executionId } = await client.workflows.run('8c2d7f1e-3a4b-4c5d-9e6f-7a8b9c0d1e2f')nodaro auth login --token "$NODARO_API_KEY"
nodaro workflows run 8c2d7f1e-3a4b-4c5d-9e6f-7a8b9c0d1e2f --watchשלושה דברים עובדים באותו אופן בכל מקום:
- אפשר להריץ הכל. הריצו תהליך שמור, אפליקציה שפורסמה או רכיב יחיד עם
POST /v1/<node-type>, בלי לבנות תהליך. - תשאול התוצאות. יצירה לוקחת בין כמה שניות לכמה דקות, ולכן הרצה מחזירה מזהה מיד, ואתם בודקים מדי כמה שניות את הסטטוס של המשימה או של ההרצה שלה. ה-SDK וה-CLI יכולים לחכות בשבילכם.
- גילוי בלי אסימון. הנתיבים
GET /v1/nodesו-GET /v1/modelsמפרטים כל רכיב וכל מודל, עם ההגדרות שלהם והמחירים שלהם בקרדיטים.
אימות
| פרטי גישה | מבנה | מתי להשתמש |
|---|---|---|
| אסימון API אישי | ndr_… | השרת, הסקריפט או משימת ה-CI שלכם קוראים ל-Nodaro בשם החשבון שלכם. יוצרים אותו בדף הגדרות › מפתחות API. |
| אסימון גישה של OAuth | ndr_app_… | המוצר שלכם מריץ תהליכים בחשבונות ה-Nodaro של המשתמשים שלכם, בהסכמתם. |
| ה-JWT של הסשן | JWT | אתם מריצים לעצמכם את מהדורת Community באירוח עצמי. |
אסימוני API זמינים ב-Nodaro Cloud ובמהדורת Business. התקנה באירוח עצמי יכולה גם להריץ את היצירות שלה על Nodaro Cloud עם אסימון API אישי, בלי OAuth. ראו את דף ה-API אימות ואת הדף אפליקציות OAuth.
מפרט OpenAPI
השרת מפרסם מפרט OpenAPI 3.1 של ליבת ה-API, בכתובת https://app.nodaro.ai/v1/openapi.json. אפשר ליצור ממנו לקוח עם טיפוסים ל-Go, ל-Rust, ל-Python או לכל שפה אחרת. ראו את דף ה-API מפרט OpenAPI.
לסוכני AI
- MCP. הוסיפו את
https://mcp.nodaro.ai/mcpכמחבר מותאם אישית ב-Claude, ב-ChatGPT, ב-Cursor ובלקוחות MCP אחרים. העוזר מזדהה עם חשבון ה-Nodaro שלכם ומקבל כלים ליצירת מדיה, לבנייה ולהרצה של תהליכים ולניהול של דמויות ושל נכסים אחרים. ראו את הדף שרת ה-MCP של Nodaro. - סקילים לסוכנים. קובצי סקילים מלמדים עוזרי קוד כמו Claude Code ו-Cursor איך להשתמש ב-SDK ואיך לבנות אפליקציית OAuth. ראו את הדף סקילים לסוכנים.
שילוב Nodaro במוצר שלכם
- הטמעת אפליקציה. אפשר להריץ אפליקציית Nodaro שפורסמה מתוך ממשק ווב או מובייל משלכם. ראו את הדף הטמעות.
- בניית הבוררים בעצמכם. הקטלוגים של בקרות יצירתיות מגיעים כנתונים בחבילה
@nodaro/prompts, כך שהאפליקציה שלכם יכולה להציע את אותן אפשרויות ולכתוב את אותם פרומפטים. ראו את הדף קטלוגי הבוררים. - התחברות משתמשים דרך ספק הזהות שלכם. ראו את הדף התחברות חיצונית (SSO).
- חיוב דרך ארנק משלכם. פריסה יכולה לאשר את ההוצאה של כל לקוח דרך ארנק משלה. ראו את הדף ארנקים חיצוניים.
מה יש בתיעוד למפתחים
REST API
הרצת תהליכים ורכיבים, תשאול משימות, העלאת מדיה וניהול נכסים דרך HTTPS.
SDK ל-TypeScript
@nodaro/sdk: מתודות ושגיאות עם טיפוסים, ופונקציות עזר לתשאול, ל-Node, לדפדפנים ולסביבות ריצה בקצה.
CLI
@nodaro/cli: הרצת תהליכים, אפליקציות ורכיבים בודדים מהטרמינל או ממשימת CI.
אפליקציות OAuth
חיבור של חשבונות ה-Nodaro של המשתמשים שלכם למוצר שלכם, עם אסימונים בהרשאות מוגבלות.
התחברות חיצונית (SSO)
התחברות להתקנת ה-Nodaro שלכם דרך ספק זהות מהימן.
קטלוגי הבוררים
בניית הבוררים של בקרות יצירתיות באפליקציה שלכם, מתוך הקטלוגים שפורסמו.
הטמעות
הרצת אפליקציה שפורסמה מתוך הממשק שלכם, או הטמעה של התצוגה המקדימה האינטראקטיבית בתלת־ממד.
ארנקים חיצוניים
אישור ההוצאה של כל לקוח דרך הארנק של הפריסה שלכם.
סקילים לסוכנים
קובצי סקילים שמלמדים עוזרי קוד להשתמש ב-SDK ולבנות אפליקציות OAuth.
שאלות נפוצות
האם יש ל-Nodaro API?
כן. ה-REST API של Nodaro, בכתובת https://app.nodaro.ai/v1/, מריץ תהליכים ורכיבים בודדים, מדווח על הסטטוס של משימות, שומר את המדיה שלכם ומנהל את הדמויות ואת שאר הנכסים שלכם. ה-API מקבל JSON ואסימון Bearer, ואותו API רץ גם בהתקנות באירוח עצמי.
האם יש SDK רשמי ל-API של Nodaro?
כן, @nodaro/sdk ל-TypeScript ול-JavaScript. ה-SDK רץ על Node.js 20 ומעלה, ובכל סביבת ריצה עם fetch ו-URL גלובליים, כולל דפדפנים, React Native, Cloudflare Workers, Deno ו-Bun.
איך סוכני AI משתמשים ב-Nodaro?
דרך שרת ה-MCP של Nodaro בכתובת https://mcp.nodaro.ai/mcp. עוזרי AI כמו Claude, ChatGPT ו-Cursor מזדהים עם חשבון ה-Nodaro שלכם, ואז יכולים ליצור מדיה, לבנות תהליכים ולהריץ אותם.
האם אפשר להשתמש ב-API במהדורת Community באירוח עצמי?
כן. בהתקנה של מהדורת Community זמינות אותן נקודות קצה, והאימות נעשה עם ה-JWT של הסשן המחובר שלכם. אסימוני API דורשים את מהדורת Business או את Nodaro Cloud, וקרדיטים קיימים רק ב-Nodaro Cloud.
במה להשתמש: אסימון API או OAuth?
השתמשו באסימון API אישי כשהשרת שלכם קורא ל-Nodaro בשם החשבון שלכם. השתמשו ב-OAuth כשאתם בונים מוצר וכל אחד מהמשתמשים שלכם מחבר אליו את חשבון ה-Nodaro שלו.
דפים קשורים
סקירה כללית של ה-REST API
SDK ל-TypeScript
ה-CLI של Nodaro
שרת ה-MCP של Nodaro
אפליקציות OAuth
עודכן לאחרונה