ข้อมูลอ้างอิง API กราฟ

ภาพรวม

API กราฟสำหรับ Workplace เป็นวิธีในทางโปรแกรมเพื่อรับข้อมูลเข้าและออกจาก Workplace โดยเป็น API บน HTTP ระดับล่างที่คุณสามารถใช้สืบค้นข้อมูลเกี่ยวกับอ็อบเจ็กต์ต่างๆ ในกราฟของ Workplace ได้

API กราฟตั้งชื่อตามแนวคิดของแบบจำลองข้อมูลกราฟ ซึ่งแสดงอ็อบเจ็กต์ด้วยโหนดและเชื่อมต่อเข้าด้วยกันตามจุดเชื่อมโยง ซึ่งเป็นวิธีการที่แอพเข้าถึงข้อมูลบน Workplace ที่ระดับ API API กราฟสำหรับ Workplace ช่วยให้มีชุดย่อยสำหรับฟังก์ชั่นการทำงานของ API กราฟ ฟังก์ชั่นการทำงานนี้ใช้ได้กับการโต้ตอบกับชุมชน Workplace เท่านั้น และอาจแตกต่างออกไปในบางกรณีเพื่อให้ประสิทธิภาพหรือความสามารถในการใช้งานที่ดีขึ้น

คุณสามารถดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีใช้ API กราฟสำหรับ Workplace ได้ที่ด้านล่างนี้

อ็อบเจ็กต์ของ API กราฟสำหรับ Workplace

โหนดต่อไปนี้เข้าถึงได้ผ่านทาง API กราฟสำหรับ Workplace ควรใช้โทเค็นการเข้าถึงการผสานการทำงานแบบกำหนดเองในการเข้าถึงโหนดทั้งหมด

ชุมชน

ชุมชน Workplace กลุ่มต้นทางสำหรับการเรียกใช้ API กราฟสำหรับ Workplace ของคุณ

กลุ่ม

กลุ่ม Workplace

โพสต์

โพสต์ที่สร้างขึ้นในกลุ่มหรือบนโปรไฟล์ของสมาชิก

สมาชิก

บัญชีสำหรับผู้ใช้ Workplace ที่เฉพาะเจาะจง

โปรดดูรายการแอพตัวอย่างเพื่อดูตัวอย่างการเรียกใช้ API กราฟต่างๆ ร่วมกันเพื่อแก้ไขปัญหาเฉพาะอย่าง

การใช้ API กราฟ

อ็อบเจ็กต์ของ API กราฟ

API กราฟเป็นการแสดงข้อมูลบน Workplace ที่ประกอบด้วย:

• โหนด - อ็อบเจ็กต์ต่างๆ เช่น ผู้ใช้ รูปภาพ โพสต์ ความคิดเห็น
• จุดเชื่อมโยง - การเชื่อมต่อระหว่าง "สิ่ง" เหล่านั้น เช่น ไฟล์ของโพสต์หรือความคิดเห็นของรูปภาพ
• ช่อง - เมตาดาต้าเกี่ยวกับอ็อบเจ็กต์ เช่น ชื่อของบุคคล หรือความเป็นส่วนตัวของกลุ่ม

ทุกๆ รายการในกราฟของ Workplace จะแสดงโดยใช้ ID ที่ไม่ซ้ำกัน กลุ่มสมาชิกโพสต์ และแม้แต่ความคิดเห็น ต่างก็มี ID เป็นของตัวเอง ซึ่งสามารถใช้เพื่อเรียกใช้ข้อมูลเกี่ยวกับอ็อบเจ็กต์เหล่านั้นได้จาก API กราฟ

การจัดการชุมชนของคุณ

ชุมชน Workplace แต่ละแห่งจะแยกออกจากชุมชนอื่นๆ คุณจึงสามารถใช้ API กราฟเพื่อเข้าถึงได้เฉพาะเนื้อหาภายในชุมชนของคุณเองและในกลุ่มที่มีหลายบริษัทซึ่งได้เพิ่มสมาชิกจากชุมชนของคุณเข้าไปเท่านั้น

ชุมชนของคุณจะถือว่าเป็นกลุ่ม เพื่อวัตถุประสงค์ในการเข้าถึง API กราฟ คุณสามารถถือว่าชุมชนของคุณเป็นกลุ่มต้นทางได้ ซึ่งกลุ่มของคุณทั้งหมดเพิ่มเข้าไปเป็นกลุ่มรองภายใต้ชุมชนนั้น หากต้องการเรียกใช้ข้อมูลเกี่ยวกับชุมชนของคุณบน API กราฟ คุณจะต้องใช้ ID ชุมชนของคุณ ซึ่งเรียกใช้ทางโปรแกรมได้จาก API กราฟโดยใช้โทเค็นการเข้าถึงแอพที่ถูกต้องสร้างคำขอ HTTP GET ไปยัง graph.facebook.com/community

การกำหนดเวอร์ชั่นของ API กราฟ

API กราฟสำหรับ Workplace สร้างขึ้นจาก API กราฟ ซึ่งหมายความว่า API ดังกล่าวจะมีลักษณะการกำหนดเวอร์ชั่น API แบบเดียวกัน

เราจะปล่อย API กราฟเวอร์ชั่นต่างๆ ออกมาทุก 3 เดือนโดยประมาณ และการเปลี่ยนแปลงที่เกิดขึ้นกับ API สำหรับ Workplace และ API กราฟทั้งหมดจะได้รับการเผยแพร่ในบันทึกการเปลี่ยนแปลง API กราฟ

เมื่อทำการเรียกใช้ API ไปยัง API กราฟ คุณจะสามารถระบุเวอร์ชั่นในพาธของ API ได้ดังนี้

      https://graph.facebook.com/v2.11/community/groups
    

อย่างไรก็ตาม มีข้อจำกัดบางประการสำหรับเวอร์ชั่นที่ใช้งานได้:

• เมื่อออกเวอร์ชั่นใหม่ เวอร์ชั่นนั้นจะกลายเป็นเวอร์ชั่นปัจจุบันของ API และได้รับการรับประกันว่าจะใช้งานได้เป็นเวลาสองปีหลังการออกเวอร์ชั่นดังกล่าว
• เมื่อสร้างแอพขึ้น แอพดังกล่าวจะมีค่าเริ่มต้นเป็นเวอร์ชั่นปัจจุบันของ API ในเวลาที่สร้างนั้น ซึ่งจะกลายเป็นเวอร์ชั่นต่ำสุดของ API ที่แอพนั้นใช้งานได้
• แอพสามารถระบุเวอร์ชั่น API ใดก็ได้โดยอิสระเมื่อทำการเรียกใช้ API แต่จะไม่สามารถทำการเรียกใช้ไปยังเวอร์ชั่น API ที่เลิกใช้แล้ว หรือเวอร์ชั่นที่ต่ำกว่าเวอร์ชั่นต่ำสุดของ API สำหรับแอพนั้นได้
• การเรียกใช้ API ที่ไม่ระบุเวอร์ชั่นจะมีค่าเริ่มต้นเป็นเวอร์ชั่นต่ำสุดของ API สำหรับแอพนั้น

เมื่อการผสานการทำงานแบบกำหนดเองถูกสร้างขึ้นใหม่ API เวอร์ชั่นต่ำสุดที่ใช้งานได้จะเป็นเวอร์ชั่นปัจจุบันของ API ในเวลาที่สร้างขึ้น เวอร์ชั่นต่ำสุดนี้จะมีผลต่อทั้งการเรียกใช้ API กราฟและการสมัครใช้บริการ Webhook

การตรวจสอบเวอร์ชั่นของ API กราฟ

หากคุณไม่แน่ใจว่าคุณกำลังใช้เวอร์ชั่นใด การตรวจสอบมีอยู่หลายวิธี คุณสามารถเพิ่มพารามิเตอร์ debug ในการเรียกใช้ API ของคุณได้ เพื่อตรวจดูว่าสามารถใช้ API กราฟเวอร์ชั่นใดได้บ้างกับแอพของคุณ

      https://graph.facebook.com/community?debug=all
    

ซึ่งการดำเนินการนี้จะส่งกลับข้อมูลการแก้ไขจุดบกพร่องเพิ่มเติมที่ยืนยันเวอร์ชั่นที่กำลังใช้อยู่

      {
         "name": "Example Community",
         "privacy": "CLOSED",
         "id": "855210357923606",
         "__debug__": {
            "messages": [
               {
                  "link": "https://developers.facebook.com/docs/apps/versions/",
                  "message": "No API version was specified. This request defaulted to version v2.8.",
                  "type": "warning"
               }
            ]
         }
      }
    

หากคุณพยายามใช้เวอร์ชั่นที่ต่ำกว่าเวอร์ชั่นต่ำสุดของ API สำหรับแอพของคุณ ข้อความ debug ก็จะบอกให้คุณทราบ

      https://graph.facebook.com/v2.6/community?debug=all
      
      {
         "name": "Example Community",
         "privacy": "CLOSED",
         "id": "855210357923606",
         "__debug__": {
            "messages": [
               {
                  "link": "https://developers.facebook.com/docs/apps/versions/",
                  "message": "The app tried to call version v2.6. This app can only call versions v2.8 and higher, so the request defaulted to version v2.8.",
                  "type": "warning"
               }
            ]
         }
      }
    

การตรวจสอบเวอร์ชั่นของ Webhook

การสมัครใช้บริการ Webhook จะใช้เวอร์ชั่นต่ำสุดของ API หากการสมัครใช้บริการนั้นดำเนินการผ่านกล่องโต้ตอบแบบป๊อปอัพ "การผสานการทำงานแบบกำหนดเอง" หรือใช้เวอร์ชั่น API ที่ระบุ หากการสมัครใช้บริการนั้นดำเนินการผ่านตำแหน่งข้อมูลของ API กราฟสำหรับการสมัครใช้บริการ นั่นคือ /app/subscriptions

คุณสามารถใช้ตำแหน่งข้อมูลของการสมัครใช้บริการเพื่อยืนยันเวอร์ชั่นของ Webhook ที่ใช้สำหรับแต่ละช่องและหัวข้อของ Webhook ได้ ตำแหน่งข้อมูลนี้ต้องใช้โทเค็นการเข้าถึงแอพ

      https://graph.facebook.com/v2.11/app/subscriptions
      
      {
        "data": [
          {
            "object": "group",
            "callback_url": "https://www.example.com/callback",
            "active": true,
            "fields": [
              {
                "name": "comments",
                "version": "v2.8"
              },
      ...
    

การใช้โทเค็นการเข้าถึง

รับโทเค็นการเข้าถึงแอพ

คุณจะต้องสร้างแอพและเรียกใช้โทเค็นการเข้าถึง หากต้องการเรียกใช้ API กราฟใดๆ สำหรับชุมชนของคุณ โดยจะรวมถึงการสร้างแอพใหม่ แล้วจึงให้สิทธิ์การอนุญาตที่จำเป็นสำหรับฟังก์ชั่นการทำงานที่คุณต้องการสร้าง

โปรดดูคู่มือสิทธิ์การอนุญาตเพื่อเรียนรู้เพิ่มเติมเกี่ยวกับการสร้างแอพและรูปแบบสิทธิ์การอนุญาต