ספריית הקהילה

client.community קורא את ספריית הקהילה: האוסף המשותף של דמויות, מיקומים ואובייקטים שצוות Nodaro בוחר בקפידה. אפשר לעיין בספרייה ולחפש בה, לקרוא פריט, לשכפל פריט לחשבון שלכם, להוסיף אותו למועדפים ולדווח עליו לבדיקה. המתודות קוראות לנקודות הקצה שבדף ה-API ספריית הקהילה. המדריך ספריית הקהילה מתאר את היכולת עצמה ואת הכללים שלה לגבי דמיון לאנשים אמיתיים והסכמה.

ספריית הקהילה קיימת בהתקנות מרובות משתמשים: Nodaro Cloud ומהדורת Business. בהתקנה של מהדורת Community, שמיועדת למשתמש יחיד, כל קריאה נכשלת עם NotFoundError.

מתודות

פרסום פריטים הוא לא חלק מה-SDK: אסימונים אישיים ואסימוני OAuth, שה-SDK עובד איתם, לא יכולים לפרסם.

client.community

פריט הוא CommunityCard. השמות של השדות שלו כתובים ב-snake_case, כמו שה-API שולח אותם. הטיפוס CommunityEntityType הוא "character", "location" או "object".

browse(params?)‎

מחזירה עמוד של פריטים ציבוריים ו-nextCursor (GET /v1/community/browse). כדי לקבל את העמוד הבא, שלחו את nextCursor בחזרה בפרמטר cursor; בעמוד האחרון הערך שלו הוא null.

browse(params?: BrowseCommunityParams): Promise<{ data: CommunityCard[]; nextCursor: string | null }>

const { data: listings, nextCursor } = await client.community.browse({
  entityType: "character",
  sort: "popular",
  limit: 20,
})

get(slug)‎

מחזירה פריט אחד לפי המזהה בכתובת שלו, ה-slug (GET /v1/community/detail/:slug).

get(slug: string): Promise<{ data: CommunityCard }>

const { data: listing } = await client.community.get("detective-mara")

כשהפריט לא קיים או שהוא כבר לא פעיל, המתודה זורקת NotFoundError.

getFull(slug)‎

מחזירה פריט אחד עם תמונת המצב הציבורית המלאה שלו: התמונות, הקול והטקסט, כפי שדף הפרטים של הפריט מציג אותם (GET /v1/community/detail/:slug/full).

getFull(slug: string): Promise<{ data: CommunityFullDetail }>

const { data: detail } = await client.community.getFull("detective-mara")

favorites()‎

מחזירה את הפריטים שהוספתם למועדפים (GET /v1/community/favorites).

favorites(): Promise<{ data: CommunityCard[] }>

const { data: favorites } = await client.community.favorites()

clone(id, entityType)‎

מעתיקה פריט לספרייה שלכם כעותק עצמאי (POST /v1/community/listings/:id/clone). הקבצים של הפריט מועתקים לאחסון שלכם, ולכן העותק נשאר כמו שהוא גם כשהמקור משתנה או נמחק. המתודה מחזירה את הסוג ואת המזהה של הנכס החדש שלכם.

clone(id: string, entityType: "character" | "location" | "object"): Promise<{ entityType: string; id: string }>

const { id: characterId } = await client.community.clone(listingId, "character")
const character = await client.characters.get(characterId)

אסימון OAuth צריך את ההרשאה assets:write. כשהאחסון שלכם מלא, המתודה זורקת StorageExceededError.

favorite(id)‎

מוסיפה פריט למועדפים שלכם, או מסירה אותו מהם כשהוא כבר שם (POST /v1/community/listings/:id/favorite). המתודה מחזירה את המצב החדש.

favorite(id: string): Promise<{ favorited: boolean }>

const { favorited } = await client.community.favorite(listingId)

report(id, reason)‎

מדווחת על פריט לבדיקה (POST /v1/community/listings/:id/report).

report(id: string, reason: CommunityReportReason): Promise<{ ok: true }>

await client.community.report(listingId, "real_person_no_consent")

client.keepers

client.keepers קורא את Nodaro Keepers, המדף המשותף של דמויות, יצורים, מיקומים ואובייקטים שמנהלי הפלטפורמה בוחרים, ומעתיק פריט מהמדף לחשבון שלכם. המתודות קוראות לנתיבים שבדף ה-API Nodaro Keepers: הקטלוג המשותף. קריאת המדף לא דורשת פרטי גישה, ולכן גם אורח יכול לעיין בו. הקריאה וההעתקה לא עולות קרדיטים.

catalog(params?)‎

מחזירה עמוד אחד של המדף: { data: KeeperCatalogItem[], next }.

catalog(params?: { kind?: KeeperKind; cursor?: string; limit?: number }): Promise<KeeperCatalogPage>

כל פריט הוא { id, kind, name, description, imageUrl, previewUrl, category, sort, createdAt }. השדה previewUrl הוא עותק של התמונה הראשית ברוחב 480 פיקסלים, לתצוגה באריח. השדה category הוא הכותרת על המדף, והשדה sort קובע את הסדר על המדף. במדף יש רק שדות תצוגה. התגובה נשמרת במטמון לדקה, וכתובת IP אחת יכולה לקרוא את המדף עד 60 פעמים בדקה.

const { data, next } = await client.keepers.catalog({ kind: "character" })

copy(kind, id)‎

מעתיקה פריט מהמדף לחשבון שלכם ומחזירה { id, name, kind, created }. השדה id מזהה את הרשומה שלכם: טענו אותה עם client.characters.get(id) ועם שאר המתודות של הנכסים.

copy(kind: KeeperKind, id: string): Promise<CopyKeeperResult>

• העותק כולל את הטקסט הציבורי, את התמונה הראשית ואת הקבצים של הווריאנטים. כל קובץ מועתק לאחסון שלכם ונספר בו.
• קול מוכן מראש או קול מהספרייה עובר לעותק. מקול מותאם אישית או משוכפל נשארים רק השם והדוגמה שלו. הבחירות של הבעלים בבוררים, תמונות הייחוס ושדות המודל המאומן אף פעם לא עוברים.
• העותק נכנס לפרויקט ברירת המחדל שלכם. העותק לא משתנה כשהמקור משתנה.
• עותק אחד לכל אדם ולכל פריט: קריאה מאוחרת יותר מחזירה את אותו עותק עם created: false. עותק שהעברתם לארכיון חוזר מהארכיון, ועותק שכבר יש לכם נשאר שלכם, בין שהפריט עדיין על המדף ובין שלא.
• המתודה זורקת NotFoundError על פריט שלא נמצא על המדף כשאין לכם עותק שלו, שגיאת 413 storage_limit_exceeded כשהקבצים שלו לא נכנסים באחסון שלכם, ו-ForbiddenError עם personal_space_disabled כשהארגון שלכם סגר את המרחב האישי.
• אסימון של אפליקציית OAuth צריך את ההרשאה assets:write.

const { id } = await client.keepers.copy("character", item.id)
const mine = await client.characters.get(id)