ניהול הפרופיל של הארגון

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

בקטעים הבאים מוסבר מהו פרופיל הארגון ואיך אפשר לנהל אותו באמצעות ממשק המשתמש ו-API.

מידע על פרופיל הארגון

במסגרת ההגדרה הראשונית של מונטיזציה, צוות ההגדרה של Apigee Edge מגדיר את פרופיל הארגון שלכם.

צריך לערוך את פרופיל הארגון כדי להוסיף או לעדכן מידע על הארגון, לפי הצורך. לדוגמה, יכול להיות שתצטרכו לעדכן את סוג החיוב, את הגדרות המטבע או את מודל המס.

מגדירים פרטים בסיסיים על הארגון, כולל:

• שם הארגון, הכתובת והמדינה שבה הוא פועל
• סוג החיוב (תשלום מראש, תשלום לאחר השימוש או שניהם), כפי שמתואר במאמר הסבר על סוג החיוב
• מחזור חיובים (יחסי או חודש קלנדרי)
• מטבע בסיס
• מודל המס שבו הארגון משתמש

אתם יכולים לנהל את פרופיל הארגון באמצעות ממשק המשתמש ו-API, כמו שמתואר בקטעים הבאים.

הדף 'פרופיל הארגון'

ניגשים לדף 'פרופיל הארגון', כמו שמתואר בהמשך.

עריכת פרופיל הארגון באמצעות ממשק המשתמש

כדי לערוך את פרופיל הארגון באמצעות ממשק המשתמש:

1. נכנסים אל דף הפרופיל של הארגון.
2. לוחצים על עריכה.
3. בקטע Name and information, עורכים את שם הארגון ואת המדינה שבה הוא פועל.
4. בקטע מיסים ומטבע, עורכים את השדות הבאים:

   שדה	תיאור
   מודל מס	הערה: האפשרות הזו רלוונטית רק אם הגדרתם תוכניות עם שיעור חלוקת הכנסות ואתם רוצים ליצור מסמכי חיוב. מודל מס לתוכניות תעריפים של חלוקת הכנסות שמזהה את סוג מסמכי החיוב הנדרשים. הערכים התקפים כוללים: גילוי נאות: ספק ה-API פועל כסוכן גלוי של המפתח. ההכנסה ברוטו (כולל מס מכירות) שמתקבלת ממשתמש הקצה מועברת אל המפתח. העמלה של ספק ה-API נגבית מהמפתח בצורה של חשבונית עמלה. ספק ה-API לא מטפל במס המכירות שנאסף ממשתמש הקצה, והאחריות לדיווח על מס המכירות מוטלת על המפתח. לא גלוי: ספק ה-API פועל כסוכן לא גלוי של המפתח, מנכה את המס שנאסף ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות. המפתח מנפיק לספק ה-API חשבונית על חלקו בהכנסות נטו (לאחר הפחתת מיסי מכירה ועמלת ספק ה-API). היברידי: ספק ה-API פועל כסוכן גלוי של המפתח. עם זאת, ספק ה-API משלם את מס המכירות שנאסף מהמנויים לרשויות המס המקומיות בשם המפתח. ספק ה-API מעביר את ההכנסות שנותרו למפתח, ואז מוציא חשבונית על חיובים של עמלות.
   מטבע	המטבעות שהארגון שלכם תומך בהם. בתוכניות של חלוקת הכנסות, כרטיס תעריפים ותשלום בלבד, המטבע שמוגדר כברירת מחדל משמש לתוכנית התעריפים. כשיוצרים כרטיס תעריפים או תוכנית עם עמלות בלבד, אפשר לבחור מתוך רשימה של מטבעות נתמכים את המטבע שבו רוצים להשתמש. אפשר גם להגדיר לכל מטבע את סכום הטעינה המינימלי שמפתחי אפליקציות יכולים להוסיף ליתרה בחשבון התשלום מראש שלהם. כדי להוסיף מטבע: לוחצים על הוספת מטבע. בוחרים מטבע מהתפריט הנפתח בשדה מטבע. אפשר גם להגדיר את הסכום המינימלי שמפתחי אפליקציות יכולים להוסיף ליתרת חשבון התשלום מראש במטבע שצוין בשדה Minimum top-up (סכום מינימלי להפקדה). לוחצים על הוספה. אם רוצים, לוחצים על לחצן הבחירה שמשויך למטבע כדי להגדיר אותו כמטבע ברירת המחדל. כדי להוסיף עוד מטבעות, חוזרים על השלבים. כדי למחוק מטבע, מציבים את הסמן מעל המטבע שרוצים למחוק ולוחצים על .

5. ניהול התנאים וההגבלות, כפי שמתואר במאמר ניהול התנאים וההגבלות באמצעות ממשק המשתמש.
6. לוחצים על שמירה.

ניהול פרופיל הארגון באמצעות ה-API

אפשר לנהל את פרופיל הארגון באמצעות ה-API, כמו שמתואר בקטעים הבאים.

הצגת פרופיל הארגון באמצעות ה-API

כדי לראות את הפרופיל של הארגון, שולחים בקשת GET אל /mint/organizations/{org_name}. לדוגמה:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Accept: application/json" \
  -u email:password

בהמשך מופיעה דוגמה לתגובה. מידע נוסף על האפשרויות שמוצגות זמין במאמר מאפייני ההגדרה של פרופיל הארגון ב-API.

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

עריכת פרופיל הארגון באמצעות ה-API

כדי לערוך את פרופיל הארגון, שולחים בקשת PUT אל /mint/organizations/{org_name}. כשעורכים את פרופיל הארגון, צריך לציין את כל המאפיינים של פרופיל הארגון, ולא רק את המאפיינים שרוצים לערוך.

כדי לערוך את מטבע ברירת המחדל של הארגון, מגדירים את הערך currency לקוד המטבע ISO 4217 של המטבע הנתמך שרוצים להגדיר כמטבע ברירת המחדל.

לדוגמה, הקריאה הבאה ל-API מעדכנת את currency לדולר ארה"ב ואת הגדרת מודל המס ל-HYBRID (השדות המעודכנים מודגשים בדוגמה). מידע נוסף על האפשרויות שמוצגות זמין במאמר מאפייני ההגדרה של פרופיל הארגון ב-API.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

הגדרת סוגי חיוב מראש וחיוב לאחר השימוש באמצעות ה-API

אפשר להגדיר בחשבונות של מפתחים את סוגי החיוב הבאים: תשלום מראש, תשלום לאחר השימוש או שניהם.

בחשבונות עם תשלום מראש, מפתחים משלמים מראש על השימוש בממשקי ה-API שלכם. הכספים מנוכים מהיתרה מההפקדה של המפתח, שמתעדכנת דרך ספק תשלומים משולב. למפתחים צריך להיות יתרה מההפקדה מספקת כדי לרכוש את ממשקי ה-API.

בחשבונות בתשלום בסוף החודש, המפתחים מחויבים מדי חודש (באמצעות חשבונית) בסוף החודש. המפתח משלם על השימוש במוצרי API בהתאם לתנאי התשלום שמוגדרים בתוכניות שכלולות בחשבונית.

כדי להגדיר את סוגי החיוב בתשלום מראש ובתשלום בסוף התקופה בארגון, צריך להגדיר את המאפיין supportedBillingType לאחד מהערכים הבאים כדי לציין אילו סוגי חיוב תקפים: PREPAID,‏ POSTPAID או BOTH. אם מגדירים את הערך BOTH, ברירת המחדל תהיה PREPAID כשמוסיפים מפתח אפליקציה או חברה. במקרה כזה, אפשר להגדיר באופן מפורש את סוג החיוב של חברה או מפתח אפליקציות באמצעות ה-API, כמו שמתואר במאמר ניהול חברות ומפתחי אפליקציות.

לדוגמה:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

הגדרת מחזור החיוב באמצעות API

כדי להגדיר את מחזור החיובים של הארגון, מגדירים את המאפיין billingCycle לאחד מהערכים הבאים:

• ‫PRORATED: החיוב מבוסס על מספר הימים שבהם נעשה שימוש במוצר API בחודש קלנדרי.
• ‫CALENDAR_MONTH: החיוב מתבצע מדי חודש.

לדוגמה:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

מאפייני ההגדרה של פרופיל הארגון עבור ה-API

פרופיל הארגון מאפשר לכם להגדיר את מאפייני התצורה הבאים באמצעות ה-API.

שינוי ההגדרות של פרופיל המונטיזציה של חברה או של מפתח אפליקציות

אפשר לבטל את ההגדרות של פרופיל המונטיזציה עבור חברה או מפתח אפליקציות באמצעות ממשק המשתמש או ה-API, כמו שמתואר בקטעים הבאים:

• ניהול מאפיינים מותאמים אישית למפתחי אפליקציות
• ניהול חברות ומפתחי אפליקציות
• ניהול מפתחי אפליקציות