תיעוד למפתחים
שאלות ותשובות למפתחים
תשובות ישירות על כינויי npm, בחירה בין API ל-MCP, אימות, מדיה, ניסיונות חוזרים בטוחים, מגבלות קצב והמשמעות האמיתית של פרסום.
קריאה בפורמט Markdownנבדק על ידי צוות SosoAPI ·
האם ארבע חבילות ה-npm הן ערכות SDK שונות?
לא. התקינו sosoapi או אחד מכינוייו: @sosoapi/cli, sosoapi-cli או sosoapi-mcp. כל כינוי משתמש בדיוק באותה גרסה של מימוש ה-CLI וה-MCP. צריך רק אחד.
האם להשתמש ב-HTTP, ב-CLI או ב-MCP?
השתמשו ב-HTTP מהשרת שלכם, ב-CLI לאוטומציית shell ולבדיקת סכמות, או ב-MCP עם סוכן תואם. הם משתמשים באותם חוזי API ציבוריים. MCP מספק גם העלאת קבצים מקומיים וכלי לפרסום תמונה מ-URL שמטפל עבורכם בהכנת המדיה. השאירו אמצעי גישה לשרת מחוץ לקוד הדפדפן.
האם הגדרה או הסכמת OAuth מפרסמות פוסט?
לא. ההגדרה אינה מפרסמת דבר. הסכמת OAuth מעניקה גישה מתמשכת בהיקף שבחרתם, ללא אישור חדש בדפדפן לכל כתיבה. אמרו לסוכן מתי להמתין לבדיקה ובדקו את החשבון, התוכן והשעה לפני שתבקשו לפרסם.
האם HTTP 200 או 202 פירושם שפורסם?
לא. הבקשה עשויה להיות במצב שהתקבלה, תוזמנה או עדיין בעיבוד. שמרו את מזהה הפוסט וקראו את אותו Scheduled Post עד שהתוצאה תאשר פרסום. כללו קישור קבוע כשהוא זמין ודווחו תוצאה לכל יעד בנפרד.
האם אפשר לנסות שוב לאחר חריגה מזמן ההמתנה?
בדקו תחילה את הפעולה הקיימת. שמרו את מזהה Scheduled Post והשתמשו שוב באותו מפתח אידמפוטנטיות לאותה בקשה. שינוי המטען יוצר בקשה אחרת. כדי לנסות שוב, לעדכן או לבטל פוסט קיים, השתמשו בגרסה הנוכחית שלו ובפעולה ש-SosoAPI מציע למצב הזה.
למה חסר כלי בלקוח שלי?
בדקו את הפרופיל, סוג החיבור והאם הלקוח טען מחדש את השרת. core מסתיר כלי ניהול; חיבורי HTTP אינם כוללים העלאת קבצים מקומיים. תיעוד הכלים מפרט זמינות. שינוי הפרופיל אינו משנה הרשאות חשבון או התאמה.
האם MCP מרוחק יכול להעלות קובץ מקומי?
לא. השתמשו ב-MCP מקומי להעלאת קובץ מתיקייה מותרת, או ייבאו URL ציבורי למדיה דרך HTTP. בדקו את הייבוא עד שהוא מוכן, ואז השתמשו יחד במזהה הנכס הרשום וב-URL הקנוני שלו. ייבוא שהתקבל עדיין בתהליך.
מהן מגבלות הקצב והמסלול?
בדקו בכל סכמה את מגבלות השדות, הרשימות והדפדוף. studio-api מאפשר 240 בקשות לדקה למשתמש להפעלות אנושיות, עם מכסה נפרדת של 480 לדקה לאמצעי הגישה המכונתיים של אותו משתמש. פעלו לפי 429 ו-Retry-After. מכסות מסלול, מגבלות ספק והתאמת חשבון נפרדות; קראו מידע חיוב ויכולות עדכני לפני הרצה גדולה.
איפה נמצאים Markdown וסכמות?
הוסיפו .md ל-URL של מדריך, פעולת API או כלי MCP כדי לקבל גרסת Markdown. אינדקס ה-API מקשר לחוזה JSON הציבורי ולמסמך OpenAPI 3.1. התחילו ב-llms.txt לאינדקס עמודים, או ב-llms-full.txt לתיעוד המלא בשתי השפות. הקבצים מכילים תיעוד ציבורי, ולא נתוני חשבון או אמצעי גישה.
האם התיעוד מבטיח הופעה בחיפוש או ציטוטי AI?
לא. עמודי HTML, כתובות URL קנוניות, מטא-נתונים מובנים ו-Markdown עוזרים למערכות לקרוא את התיעוד. מנועי חיפוש ושירותי AI עדיין בוחרים מה לאנדקס, לדרג או לצטט. בדקו את התוצאות האלה בנפרד מזמינות העמודים.