เริ่มต้นใช้งาน

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


ขั้นตอนที่ 1:

เรียกดู API และเว็บฮุค

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

  • ไปที่ แค็ตตาล็อก API เพื่อเรียกดู
  • เลือก API หรือเว็บฮุคเพื่ออ่านภาพรวม สำรวจบันทึกการเปลี่ยนแปลง และทบทวนคุณสมบัติสำคัญต่างๆ
ภาพถ่ายหน้าจอของหน้า API การจัดส่ง
  • ทบทวนเอกสารเพื่อเรียนรู้เพิ่มเติมเกี่ยวกับองค์ประกอบของคำขอและการตอบกลับ ตัวอย่างภาษาชุดคำสั่งที่มีให้เลือก รหัสข้อผิดพลาด และอื่นๆ
ภาพถ่ายหน้าจอของหน้าสร้างการจัดส่ง
  • ดูหน้า ประกาศ สำหรับการอัปเดตบริการตามแผนที่กำหนดและติดตามข่าวสารล่าสุด

ขั้นตอนที่ 2:

ลงทะเบียนหรือเข้าสู่ระบบ

เข้าสู่ระบบด้วย ID ผู้ใช้และรหัสผ่าน fedex.com ของคุณ เพื่อเริ่มต้นการผสานรวมเข้ากับ FedEx API และเว็บฮุค

หากคุณยังไม่มี ID ผู้ใช้ คุณสามารถ ลงทะเบียน ได้โดยไม่เสียค่าใช้จ่าย


ขั้นตอนที่ 3:

สร้างหรือเข้าร่วมองค์กร

ให้สร้างองค์กร หากยังไม่มีองค์กรสำหรับบริษัทของคุณ หรือเข้าร่วมองค์กรที่มีอยู่แล้วของบริษัท

หากต้องการสร้างองค์กร:

หากคุณสร้างองค์กร บทบาทของคุณจะปรากฏเป็นผู้ดูแลระบบขององค์กรนั้นโดยอัตโนมัติ

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

หากต้องการสร้างองค์กรของคุณเอง ให้คลิกที่ สร้างองค์กร ในการนำทางด้านซ้ายมือ

ระบุข้อมูลองค์กร

  • ระบุชื่อบริษัท URL เว็บไซต์ และสร้างชื่อองค์กร ตั้งชื่อให้กับองค์กรที่ผู้ใช้คนอื่นๆ จะจดจำได้ โดยชื่อนี้สามารถใช้เพื่อจัดระเบียบบริษัทของคุณเป็นกลุ่มที่เฉพาะเจาะจงมากขึ้น (เช่น แผนก ส่วนงาน ภูมิภาค สถานที่) หรืออาจเป็นชื่อเดียวกับชื่อบริษัทของคุณ
ภาพถ่ายหน้าจอของหน้าสร้างองค์กรของคุณ

หากต้องการเข้าร่วมองค์กร:

คุณสามารถเข้าร่วมองค์กรที่มีอยู่แล้วได้โดยทำตามขั้นตอนต่อไปนี้:

  1. ขอให้ผู้ดูแลระบบขององค์กรของคุณส่งคำเชิญให้คุณ
  • หากบริษัทของคุณสร้างองค์กรไว้แล้ว คุณสามารถขอให้ผู้ดูแลระบบขององค์กรนั้นส่งคำเชิญเข้าร่วมให้กับคุณ คุณจะมีเวลา 24 ชั่วโมงในการตอบรับคำเชิญ แต่ถ้าหากคุณไม่สามารถตอบรับคำเชิญได้ทันตามกรอบเวลาดังกล่าว คุณสามารถขอให้ผู้ดูแลระบบส่งคำเชิญใหม่อีกครั้งได้เสมอ

  1. ยอมรับคำเชิญ
  • ในการตอบรับคำเชิญ คุณจำเป็นต้องเข้าสู่ระบบด้วย ID ผู้ใช้และรหัสผ่านที่มีอยู่แล้วของคุณ หรือหาก ID ผู้ใช้ที่มีอยู่แล้วนั้นเชื่อมโยงกับองค์กรอื่นแล้ว คุณต้องสร้างใหม่

ขั้นตอนที่ 4:

เพิ่มบัญชีการจัดส่ง

  1. ระบุข้อมูลบัญชีให้ครบถ้วน
  • ระบุหมายเลขบัญชีของคุณ ชื่อย่อของบัญชี และที่อยู่สำหรับเรียกเก็บเงินที่เชื่อมโยงกับบัญชี เราจะทำการตรวจสอบที่อยู่สำหรับเรียกเก็บเงินว่าตรงกันกับรายละเอียดของบัญชีหรือไม่ เพื่อป้องกันไม่ให้เกิดกิจกรรมที่เป็นการทุจริต
  • หากต้องการดูบัญชีการจัดส่งที่เชื่อมโยงกับ ID ผู้ใช้ของคุณ ให้ไปที่หน้า จัดการองค์กร และแตะที่ บัญชีการจัดส่ง หากต้องการสร้างบัญชีการจัดส่งใหม่ กรุณาติดต่อ เจ้าหน้าที่ฝ่ายขายของ FedEx ของคุณ
ภาพถ่ายหน้าจอของหน้าเพิ่มบัญชีการจัดส่ง

  1. ข้อตกลงการอนุญาตใช้สิทธิ์ของผู้ใช้งาน
  • จากนั้นคุณต้องยอมรับ ข้อตกลงการอนุญาตใช้สิทธิ์ของผู้ใช้งาน (EULA) หรือส่งไปยังบุคคลอื่นภายในบริษัทผู้ใช้ปลายทางที่สามารถยอมรับข้อตกลงได้ คุณสามารถดูสถานะของ EULA ได้ในหน้าจัดการองค์กร ภายใต้แท็บ บัญชีการจัดส่ง

     

ภาพถ่ายหน้าจอของหน้าดำเนินการจัดทำ EULA

ขั้นตอนที่ 5:

เพิ่มผู้ใช้สู่องค์กรของคุณ

ผู้ดูแลระบบสามารถเชิญผู้ใช้ให้เข้าร่วมองค์กร และกำหนดบทบาทและโครงการให้กับผู้ใช้ได้ เมื่อต้องการเริ่มต้น คุณสามารถ เพิ่มผู้ใช้ จากหน้าจัดการองค์กรโดยทำตามขั้นตอนต่อไปนี้ (ขั้นตอนที่มีเครื่องหมาย * นั้นไม่บังคับ):

  1. ระบุที่อยู่อีเมลของผู้ใช้

  • ระบุที่อยู่อีเมลของผู้ใช้ที่คุณต้องการเชิญให้เข้าร่วมองค์กรของคุณ คุณสามารถระบุที่อยู่อีเมลได้หลายรายการโดยใช้การเว้นวรรค เครื่องหมายจุลภาค อัฒภาค หรือกดปุ่มที่อยู่บนแป้นพิมพ์ระหว่างที่อยู่
  1. เลือกบทบาทของผู้ใช้

  • เลือกบทบาทของผู้ใช้อื่นหากตัวเลือกเริ่มต้นของผู้ชมไม่ตรงกับความต้องการของผู้ใช้*
  1. กำหนดผู้ใช้ให้กับโครงการ

  • หากคุณสร้างโครงการแล้ว คุณสามารถกำหนดผู้ใช้ให้กับโครงการได้*
ภาพถ่ายหน้าจอของหน้าเพิ่มผู้ใช้

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

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

  • คลิกที่สัญลักษณ์รูปตัววีคว่ำที่อยู่ด้านข้างของบทบาทหรือโครงการ จะปรากฏเมนูตัวเลือกที่ประกอบด้วยตัวเลือกต่างๆ ขึ้นมา
  • เลือกตัวเลือก จากนั้นเลือกปุ่ม ปรับใช้ เพื่อบันทึกการเลือกของคุณ
ภาพถ่ายหน้าจอของหน้าจัดการองค์กร


ขั้นตอนที่ 1: 

สร้างโครงการเพื่อรับข้อมูลประจำตัว

ในหน้า โครงการของฉัน ให้ไปที่แท็บ API
 

ผู้ดูแลระบบหรือผู้สนับสนุนองค์กรของคุณสามารถสร้างโครงการ API ได้โดยคลิกที่ปุ่ม สร้างโครงการ API

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

หากคุณระบุว่าเป็นผู้ส่ง คุณจะสามารถเริ่มสร้างโครงการของคุณได้ นี่คือกระบวนการทั้งสามขั้นตอน:

  1. เลือก API

เลือก API ที่คุณต้องการรวมไว้ในโครงการของคุณ ซึ่งคุณอาจต้องทำการเลือกเพิ่มเติมขึ้นอยู่กับ API ที่คุณเลือก

หากคุณเลือก API สำหรับการติดตามคุณจะต้อง:

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

  1. จัดการโครงการ

ระบุรายละเอียดเฉพาะของโครงการ รวมถึงชื่อและสถานที่จัดส่ง

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

  1. ยืนยันรายละเอียด

ตรวจสอบรายละเอียดโครงการของคุณ จากนั้นยอมรับระเบียบและเงื่อนไข

  • อ่านและยอมรับ ข้อตกลงการอนุญาตใช้สิทธิ์สำหรับ FedEx Developer Portal และยอมรับว่าคุณไม่มีเจตนาที่จะจำหน่ายหรือแจกจ่ายแอปพลิเคชันของคุณ
  • เมื่อคุณคลิกปุ่ม "สร้าง" คุณจะเห็นหน้าจอยืนยันปรากฏขึ้น จากนั้น คุณจะสามารถดูข้อมูลประจำตัวสำหรับทดสอบภายในโครงการใหม่ของคุณได้
step3

ขั้นตอนที่ 2:

ผสานรวม API และทดสอบการใช้งาน

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

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

ขั้นตอนที่ 3:

นำโครงการของคุณไปใช้งานในระบบจริง

คลิกที่แท็บ รหัสสำหรับใช้งานจริง ตอนนี้คุณสามารถเริ่มต้นย้ายโครงการของคุณไปใช้งานในระบบจริงได้โดย
ดำเนินการตามขั้นตอนดังต่อไปนี้

 

ภายในขั้นตอน กำหนดค่าโครงการ:

  • คุณสามารถเปลี่ยนชื่อรหัสของคุณได้ตามต้องการ
  • ตรวจสอบหมายเลขบัญชีที่คุณเลือกในขั้นตอนที่ 1 ของขั้นตอนการสร้างโครงการ ซึ่งใช้เพื่อย้ายโครงการของคุณไปใช้งานในระบบจริง เมื่อโครงการของคุณอยู่ในระบบจริงแล้ว คุณสามารถเพิ่มบัญชีเพิ่มเติมได้ตามต้องการ
production key tab

ภายในขั้นตอน รับรหัสโครงการ:

  • รหัส API และรหัสลับสำหรับใช้งานจริงของคุณจะปรากฏขึ้น ให้คัดลอกรหัสเก็บไว้ในที่ปลอดภัย
  • เพื่อให้รหัสลับสำหรับใช้งานจริงของคุณปลอดภัย เราจะแสดงรหัสครั้งเดียวเท่านั้น หากคุณลืมรหัสลับ คุณสามารถสร้างรหัสชุดใหม่ได้
  • คลิก ถัดไป
production key step2

ตอนนี้คุณจะถูกพากลับไปที่หน้า ภาพรวมโครงการ โดยคุณสามารถเพิ่มบัญชีที่เกี่ยวข้องกับโครงการของคุณได้ที่นี่

ในหน้า ภาพรวมโครงการ:

  • คลิกที่จุดแนวตั้ง 3 จุด (หรือเมนูเคบับ) เพื่อเพิ่มบัญชีที่เกี่ยวข้องกับโครงการของคุณ
  • จากนั้นคลิกที่ แก้ไข

ระบบจะนำคุณไปยังหน้า รหัส API ซึ่งคุณสามารถเพิ่มบัญชีเพิ่มเติมที่คุณต้องการเชื่อมโยงกับรหัสสำหรับใช้งานจริงสำหรับโครงการนี้

API project overview after steps

ขั้นตอนที่ 4:

ดำเนินการรับรองให้สมบูรณ์

  1. API บางส่วนต้องมีการรับรองฉลากการจัดส่งเพื่อใช้ในระบบใช้งานจริงของเรา กรุณาดำเนินการรับรองสำหรับ API ในโครงการของคุณที่มีข้อกำหนดนี้ให้เสร็จสมบูรณ์
API Certification
  1. หลังจากที่ API ทั้งหมดได้รับการรับรองและเปิดใช้งานแล้ว ให้อัปเดตคำขอ API ของคุณโดยการเปลี่ยน URI รหัส และบัญชีการจัดส่งสำหรับทดสอบให้เป็น URI รหัส และบัญชีการจัดส่งสำหรับใช้งานจริงแทน

  2. ทดสอบการใช้งานของคุณใหม่อีกครั้งในระบบใช้งานจริงโดยใช้ข้อมูลตัวอย่าง

  3. รับสิทธิประโยชน์ต่างๆ จากการผสานรวมใหม่นี้ได้เลย


ข้อกำหนดเบื้องต้นสำหรับการสร้างโครงการเว็บฮุค


ขั้นตอนที่ 1:

สร้าง URL ที่ถูกต้องในแอปพลิเคชัน/แพลตฟอร์มปลายทางของคุณ

สร้าง URL ที่ถูกต้องในแอปพลิเคชัน/แพลตฟอร์มปลายทางของคุณเพื่อรับรหัส/ข้อความการรับรอง และการแจ้งเตือนน้ำหนักบรรทุกของ Tracking Webhook จาก FedEx

ข้อกำหนด URL:

 

  • อนุญาตเฉพาะโปรโตคอล HTTPS เท่านั้น
  • URL ของคุณจะถูกบล็อกหากตรงตามเงื่อนไขข้อใดข้อหนึ่งต่อไปนี้:
    • ประกอบด้วยที่อยู่ IP RFC1918
    • ประกอบด้วย fedex.com หรือโดเมนย่อยใดๆ
    • ประกอบด้วยที่อยู่ IP ใน URL (รวมถึง localhost, 127.0.0.1)
  •  


    ขั้นตอนที่ 2:

    สร้างโทเค็นรักษาความปลอดภัย

    โทเค็นรักษาความปลอดภัยนี้สามารถใช้เป็นรหัสลับในการรับรองและตรวจสอบข้อมูลที่ส่งผ่านระหว่างคุณ (ลูกค้า) และ FedEx

    ข้อกำหนดโทเค็นรักษาความปลอดภัย:

    • อักขระต่ำสุด 25 ตัวและสูงสุด 100 ตัว
    • อักขระตัวพิมพ์ใหญ่ 1 ตัว
    • อักขระตัวพิมพ์เล็ก 1 ตัว
    • อักขระตัวเลข 1 ตัว
    Security token

    ขั้นตอนที่ 3:

    ทดสอบ URL เว็บฮุค

    การทดสอบ URL ของคุณเป็นขั้นตอนเสริมที่คุณอาจพบว่าเป็นประโยชน์

    การทดสอบสามารถช่วยให้คุณเข้าใจได้ดีขึ้นว่า URL ที่คุณสร้างในขั้นตอนที่ 1 นั้นถูกต้องหรือไม่ และช่วยให้ FedEx สามารถระบุ URL ของคุณและสร้างการเชื่อมต่อกับ URL ของคุณเพื่อส่งข้อมูลได้ การทดสอบยังสามารถระบุตัวอย่างข้อมูลการทดสอบที่สามารถช่วยคุณตรวจสอบและยืนยันว่าคุณสามารถประมวลผลข้อมูลการติดตามที่ให้ไว้ในแอปพลิเคชันของคุณได้หรือไม่ อย่างไรก็ตาม การทดสอบไม่ใช่การรับรอง URL ของคุณ

    ไปที่ เอกสารเว็บฮุค เพื่อเรียนรู้วิธีทดสอบ URL ของเว็บฮุค


    ขั้นตอนที่ 4:

    ตรวจสอบ URL ปลายทาง

    ใช้วิธีอัลกอริธึมการแฮช HMAC SHA256 เพื่อตั้งค่ากระบวนการรับรองเพื่อตรวจสอบข้อมูลที่ส่งผ่านระหว่าง URL ปลายทางของคุณและ FedEx

    screenshot of Validate destination URL
    1. เมื่อคุณคลิกที่ สร้าง FedEx จะสร้างสตริงการท้าทายแบบสุ่ม ซึ่งจะถูกส่งให้คุณในส่วนเนื้อหาคำขอ ในทางกลับกัน คุณถูกคาดหวังให้ส่งคืนสตริงการท้าทายนี้ให้กับ FedEx ในส่วนเนื้อหาการตอบกลับ
    example
    1. เริ่มต้นรหัสการรับรองข้อความ (MAC) โดยใช้อัลกอริธึม/ขั้นตอน HMAC SHA256 เพื่อแฮช (หรือรวม) สตริงการท้าทายและโทเค็นรักษาความปลอดภัย (หรือรหัสลับ) เพื่อสร้างลายเซ็นแฮช
    img2
    1. ตอบกลับ FedEx ด้วย challengeString และ ChallengeStringResponse พร้อมกันในส่วนเนื้อหาการตอบกลับ พร้อมด้วยรหัสสถานะ HTTP 200 (OK) หรือ 202 (ACCEPTED)
    image3
    1. ตอนนี้ FedEx จะตรวจสอบสตริงการท้าทายและการตอบกลับสตริงการท้าทาย
    • หลังจากที่ FedEx ได้รับส่วนเนื้อหาการตอบกลับแล้ว FedEx จะตรวจสอบ challengeString และ ChallengeStringResponse (หรือลายเซ็นแฮชที่สร้างขึ้นก่อนหน้านี้) ด้วยการเปรียบเทียบกับ ChallengeString และลายเซ็นแฮชที่สร้างโดย FedEx ตามลำดับ
    img4
    • หากทั้ง "challengeString" และลายเซ็น HMAC ตรงกัน แสดงว่าการตรวจสอบและเวิร์กโฟลว์นั้นเป็นผลสำเร็จ ไม่เช่นนั้น กระบวนการตรวจสอบจะล้มเหลว และข้อความแสดงข้อผิดพลาดที่เกี่ยวข้องจะปรากฏขึ้น

    สร้างโครงการเว็บฮุค


    ขั้นตอนที่ 1:

    สร้างโครงการเว็บฮุคเพื่อรับการแจ้งเตือนน้ำหนักบรรทุกที่กำหนดค่าไว้

    ในหน้า โครงการของฉัน ให้ไปที่แท็บ เว็บฮุค

    ผู้ดูแลระบบหรือผู้สนับสนุนองค์กรของคุณสามารถสร้างโครงการเว็บฮุคได้โดยคลิกที่ปุ่ม สร้างโครงการเว็บฮุค

    ก่อนที่จะเริ่มต้น คุณจะต้องแจ้งให้เราทราบถึงเหตุผลที่คุณจำเป็นต้องเข้าถึงเว็บฮุคของ FedEx โดยโมดอลจะปรากฏขึ้นและแสดงเมนูตัวเลือกให้กับคุณ คุณควรเลือกตัวเลือกที่ระบุความต้องการทางธุรกิจของคุณในการผสานรวมกับเว็บฮุคของ FedEx ได้ดีที่สุด

    หากคุณระบุว่าเป็นผู้ส่ง คุณสามารถเริ่มสร้างโครงการของคุณได้โดยปฏิบัติตามขั้นตอนต่อไปนี้:

    screenshot of create a webhook page
    1. ระบุความต้องการทางธุรกิจของคุณ
    • เลือกตัวเลือกที่ระบุว่าเหตุใดธุรกิจของคุณต้องการผสานรวมกับเว็บฮุคของ FedEx ได้ดีที่สุด
    identify your business needs
    1. เลือกระดับและคุณสมบัติระดับ
    • เลือกระดับเว็บฮุคพื้นฐานหรือขั้นสูงสำหรับโครงการของคุณตามความต้องการของโครงการ
    • คุณสามารถแก้ไขตัวเลือกระดับของคุณได้ในภายหลัง
    • แต่ละระดับจะมาพร้อมกับค่าธรรมเนียมการสมัครสมาชิกรายเดือน
    tire and tire features
    • เลือกคุณสมบัติที่คุณต้องการกำหนดค่าให้กับโครงการของคุณ
    • คุณยังสามารถแก้ไขคุณสมบัติของคุณได้ในภายหลัง
    feature selection
    1. กำหนดค่ารายละเอียดโครงการ
    • ตั้งชื่อโครงการของคุณที่สามารถชี้ตัวตนได้
    • ระบุ URL ปลายทางที่สร้างไว้ล่วงหน้าและรายละเอียดโทเค็นรักษาความปลอดภัย ซึ่งสร้างขึ้นระหว่างการรับรองการตั้งค่าล่วงหน้า

     

    ชื่อฟิลด์ คำอธิบาย


    ชื่อโครงการเว็บฮุค







    URL ปลายทาง

    นี่คือชื่อโครงการเว็บฮุคที่ไม่ว่างเปล่าและไม่ซ้ำใคร และไม่ควรนำไปใช้ซ้ำในโครงการเว็บฮุคอื่น

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


    นี่คือ URL ที่คุณจะได้รับข้อมูลการติดตามกิจกรรม/น้ำหนักบรรทุก

    • คุณควรระบุ URL ปลายทางที่ใช้งานได้และถูกต้อง
    • URL ปลายทางที่ระบุต้องอยู่ในรูปแบบไวยากรณ์มาตรฐาน (https URL ที่ปลอดภัย ไม่รวม fedex.com หรือโดเมนย่อยใน URL)
    • คุณสามารถทำซ้ำ URL ปลายทางในหลายเว็บฮุคได้





    โทเค็นรักษาความปลอดภัย
     

    ข้อมูลนี้ใช้เป็นความลับร่วมกันเพื่อรับรองและตรวจสอบการตอบกลับของ Tracking Webhook

    • ค่าโทเค็นต้องมีความยาวขั้นต่ำ 25 ตัวและสูงสุด 100 ตัว
    • ต้องมีตัวพิมพ์ใหญ่ 1 ตัว ตัวพิมพ์เล็ก 1 ตัว และตัวเลข 1 ตัว
    • คุณสามารถทำซ้ำโทเค็นรักษาความปลอดภัยนี้ในหลายเว็บฮุคได้
    • โทเค็นรักษาความปลอดภัยจะถูกใช้เพื่อสร้างลายเซ็นรหัสการรับรองข้อความ (HMAC) แบบแฮชสำหรับการตรวจสอบการตอบกลับ

    ภาษาน้ำหนักบรรทุก (ประเทศ)




    ประเภทการติดตาม
     

    เลือกภาษาที่ต้องการสำหรับการแปลข้อมูลการติดตามของคุณจากรายการเมนูตัวเลือก



    เลือกประเภทการตอบกลับที่ต้องการรับข้อมูลการติดตาม

    • การตอบกลับการติดตามโดยละเอียด: ประเภทการตอบกลับประกอบด้วยข้อมูลการติดตามที่ปลอดภัยที่มีประวัติกิจกรรมทั้งหมด
    • การตอบกลับการติดตามเฉพาะกิจกรรม: ประเภทการตอบกลับประกอบด้วยข้อมูลการติดตามที่ปลอดภัยที่มีเฉพาะข้อมูลกิจกรรมล่าสุดเท่านั้น


    ที่อยู่อีเมล
     

    ระบุที่อยู่อีเมลเพื่อรับการแจ้งเตือนผ่านทางอีเมลเมื่อมีการเปลี่ยนแปลงโครงการเว็บฮุคของคุณ (เช่น สร้าง แก้ไข ยกเลิก)






    ภาษาอีเมล (ประเทศ)
     

    เลือกภาษาที่คุณต้องการรับการแจ้งเตือนผ่านทางอีเมลจากเว็บฮุคจาก FedEx

    นี่คือภาษาที่รองรับสำหรับการแจ้งเตือนทางอีเมล:

    • ภาษาอังกฤษ (สหรัฐอเมริกา)
    • ภาษาองกฤษ (แคนาดา)
    • ภาษาฝรั่งเศส (แคนาดา)
    • ภาษาสเปน (สหรัฐอเมริกา)
       
    create webhook step2

    1. เลือกบัญชี
    • เลือกจากรายการหมายเลขบัญชีที่มีสิทธิ์ (อ้างอิงจากสหรัฐอเมริกาหรือแคนาดา) ที่คุณต้องการเชื่อมโยงกับโครงการของคุณ
    note

      5. ยืนยันรายละเอียดและยอมรับเงื่อนไข

    1. หากคำขอสร้างของคุณได้รับการตรวจสอบและดำเนินการเรียบร้อยแล้ว คุณจะถูกนำไปที่หน้าจอยืนยัน
    • หากการตรวจสอบไม่สำเร็จหรือล้มเหลว จะมีข้อความแสดงข้อผิดพลาดปรากฏขึ้น
    1. โครงการ Tracking Webhook ของคุณจะมี ID เว็บฮุคที่ระบบสร้างขึ้นและแสดงสถานะเป็น "กำลังใช้งาน"
    terms

    ขั้นตอนที่ 1: 

    FedEx จะสร้างองค์กรผู้ให้บริการ Compatible

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

    ขั้นตอนที่ 2:

    รับคำเชิญ

    • หากต้องการเข้าถึงการผสานรวมและเอกสาร API กรุณายอมรับคำเชิญ ในการตอบรับคำเชิญ คุณจะต้องเข้าสู่ระบบด้วย ID ผู้ใช้และรหัสผ่านของ FedEx ของคุณ หรือสร้างใหม่หากคุณยังไม่มีข้อมูลประจำตัวนี้
    Accept invite

    ขั้นตอนที่ 3:

    เชิญผู้ใช้สู่องค์กรของคุณ

    • ในฐานะผู้ดูแลระบบคุณสามารถเชิญสมาชิกในทีมที่ต้องการเข้าถึงโครงการหรือองค์กรได้ สำหรับรายละเอียดเกี่ยวกับบทบาทต่างๆโปรดดูที่คู่มือการบริหารองค์กร
    Manage org
    • หากสร้างองค์กรของคุณแล้ว กรุณาขอให้ผู้ดูแลระบบขององค์กรหรือ FedEx เชิญคุณเข้าร่วมด้วย คุณจะมีเวลา 24 ชั่วโมงในการตอบรับคำเชิญ แต่ถ้าหากคุณไม่สามารถตอบรับคำเชิญได้ทันตามกรอบเวลาดังกล่าว คุณสามารถขอให้ผู้ดูแลระบบส่งคำเชิญใหม่อีกครั้งได้

    ขั้นตอนที่ 4:

    เลือก API ที่คุณต้องการสำหรับโซลูชันของคุณ

    • ไปที่ แคตตาล็อก API เพื่อกำหนด API ที่เหมาะสมสำหรับโซลูชันของคุณ ที่ปรึกษาด้านเทคโนโลยีลูกค้าของ FedEx (CTC) และผู้จัดการ Compatible Channel ของคุณสามารถช่วยคุณเลือก API ที่เหมาะสมสำหรับโซลูชันของคุณตามความต้องการทางธุรกิจของคุณ

    API Catalog
    • เลือก API เพื่อเรียนรู้เกี่ยวกับภาพรวมบันทึกการเปลี่ยนแปลงและคุณสมบัติสำคัญต่างๆ

    Address validation API
    • ดูเอกสาร API เพื่อเรียนรู้องค์ประกอบของคำขอและการตอบสนอง ซึ่งจะแสดงตัวอย่างในภาษาที่คุณเลือก ข้อผิดพลาด และอื่นๆ

    Address validation API-intro
    • กลับไปที่ Salesforce เพื่อกรอกข้อมูลใน Product Information Worksheet (PIW) และลงรายการ API ที่คุณต้องการเพิ่มลงในโซลูชันของคุณ


    ขั้นตอนที่ 5:

    FedEx จะสร้างโครงการ

    เมื่อ PIW ได้รับการอนุมัติแล้ว FedEx จะสร้างโครงการของคุณ เวอร์ชันแต่ละตัวของแต่ละโซลูชันของคุณจะมีโครงการแยกกันอยู่ในFedEx Developer Portal หากผู้ใช้ไม่ใช่ผู้ดูแลระบบขององค์กร พวกเขาจำเป็นที่จะต้องตอบรับคำเชิญก่อนเพื่อมีสิทธิ์เข้าดูแต่ละโครงการได้ 

    นอกจากนี้ยังเป็นช่วงที่ทีมงาน FedEx Compatible พร้อมกับ FedEx CTC และทีมรับรองจะจัดการสาธิตทางเทคนิคสำหรับ API ร่วมกับทีมของคุณ ทีมงาน FedEx จะแจ้งเกี่ยวกับคุณสมบัติและฟังก์ชันใหม่ที่มีให้ในเวอร์ชันของ API ที่คุณใช้อยู่ ทีมจะสามารถตอบคำถามทางเทคนิคเกี่ยวกับ API การทดสอบ API และกระบวนการทั้งหมดที่ต้องดำเนินการให้แล้วเสร็จเพื่อเริ่มกระบวนการ ‘การรับรอง*’ สำหรับ API

    *การรับรอง – กระบวนการที่กำหนดโดยโปรแกรม FedEx Compatible เพื่อให้เป็นไปตามข้อกำหนดการปฏิบัติตามข้อกำหนดของโปรแกรม และจำเป็นต้องมีการรับรองโปรแกรม Compatible เพื่อให้แน่ใจว่าผู้ให้บริการ Compatible ทั้งหมดนำไปใช้ ทำการตลาด และแจกจ่ายเทคโนโลยีของ FedEx ให้กับผู้จัดส่ง (ลูกค้า) ตามที่กำหนดโดยเทคโนโลยีและมาตรฐานการบริการของ FedEx


    ขั้นตอนที่ 6:

    ผสานรวม API เข้ากับแอปพลิเคชันของคุณและรับรองเข้ากับโปรแกรม Compatible

    1. ถึงตอนนี้คุณสามารถใช้ API Key และ Secret Key เพื่อเริ่มทำธุรกรรมต่างๆ ได้ โดยการดึงข้อมูลเหล่านี้ในแท็บ Test Key จากหน้าภาพรวมโครงการ
    API project overview
    1. ในการสร้างรหัสของลูกค้า คุณจะต้องใช้การลงทะเบียนรับรอง API ซึ่งเป็น API ส่วนตัวที่พบเฉพาะในส่วน API ของแต่ละโครงการของคุณ
    2. เมื่อคุณสร้างรหัสของลูกค้าได้สักสองสามรายการแล้ว ต่อไปให้ขอโทเค็นการเข้าถึง OAuth เพื่อใช้กับธุรกรรม API ทุกรายการ เซสชันของโทเค็นมีอายุการใช้งานเพียง 1 ชั่วโมง ดังนั้น คุณจำเป็นต้องเขียนโค้ดด้วยโปรแกรมสำหรับแอปพลิเคชันของคุณเพื่อรีเฟรชโทเค็นก่อนที่เซสชันจะหมดอายุ หากต้องการรายละเอียดเพิ่มเติม กรุณาดูเอกสาร API การให้สิทธิ์อนุญาต เมื่อดูโค้ดตัวอย่าง ให้ตรวจสอบให้แน่ใจว่าได้เลือก "ตัวแทนจำหน่าย" จากเมนูตัวเลือกตัวอย่าง
    API Authorization
    1. เลือกเอกสารสำหรับ API ในหน้า Test Key และอ่านข้อมูลบริบททางธุรกิจเพื่อให้เข้าใจวิธีการใช้ API ที่เลือก ทบทวนคำขอตัวอย่างสำหรับปลายทางที่ตรงกับการผสานรวมที่คุณต้องการ
    2. ดำเนินการเรียกใช้ไปยังปลายทางเหล่านี้ตามที่ระบุไว้ในคำขอตัวอย่าง โดยกำหนดค่าให้ใช้ข้อมูลประจำตัวสำหรับทดสอบ
    3. ตรวจสอบว่าการตอบกลับการเรียกใช้ API ที่ได้รับนั้นตรงกับตัวอย่างที่แสดงในเอกสารแล้ว
    4. ทดสอบการใช้งานของคุณให้สมบูรณ์ภายในระบบทดสอบของ FedEx โดยใช้ข้อมูลประจำตัวสำหรับทดสอบและ URI การทดสอบของ FedEx
    5. หลังจากทำการทดสอบโซลูชันของคุณสมบูรณ์แล้ว ให้รับรองแต่ละโซลูชันใน Salesforce FedEx จะตรวจสอบทุกอย่างที่ส่งมาอย่างถี่ถ้วนและอัปเดตให้คุณทราบเมื่อการรับรองของคุณได้รับการอนุมัติ

    ขั้นตอนที่ 7:

    FedEx ย้ายโครงการไปสู่ระบบจริง

    • จากนั้น FedEx จะย้ายโครงการของคุณไปสู่การผลิต
    • จากนั้นคุณจะสามารถดูรหัส API สำหรับใช้งานจริงของคุณได้ในแท็บรหัสสำหรับใช้งานจริงของหน้าเพจภาพรวมโครงการ
    API project overview tab2

    ขั้นตอนที่ 8:

    สร้าง Secret Key สำหรับระบบจริง

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