จะสร้างคีย์ API สำหรับ REST API ได้อย่างไร
หากต้องการสร้างคีย์ API คุณต้องลงทะเบียนแอพและเชื่อมโยงกับผลิตภัณฑ์ API. อย่างไรก็ตาม คุณไม่สามารถลงทะเบียนแอปได้หากไม่ได้ลงทะเบียนผู้พัฒนาแอปก่อน หมายเหตุ: หากคุณมีผลิตภัณฑ์ API สาธารณะที่นักพัฒนาสามารถลงทะเบียนผ่านพอร์ทัล นักพัฒนาสามารถลงทะเบียนด้วยตนเองได้
หากต้องการสร้างคีย์ API คุณต้องลงทะเบียนแอพและเชื่อมโยงกับผลิตภัณฑ์ API. อย่างไรก็ตาม คุณไม่สามารถลงทะเบียนแอปได้หากไม่ได้ลงทะเบียนผู้พัฒนาแอปก่อน หมายเหตุ: หากคุณมีผลิตภัณฑ์ API สาธารณะที่นักพัฒนาสามารถลงทะเบียนผ่านพอร์ทัล นักพัฒนาสามารถลงทะเบียนด้วยตนเองได้
- ภาพรวม
- การตั้งค่าสภาพแวดล้อมของคุณ
- ตรวจสอบที่เก็บ GitHub
- สร้างแอปพลิเคชัน
- เติมตัวแปรสภาพแวดล้อมของโครงการ
- เรียกใช้รหัส
- สร้างบัญชีนักพัฒนา
คีย์ Application Programming Interface (API) คือรหัสที่ใช้ในการระบุและรับรองความถูกต้องของแอปพลิเคชันหรือผู้ใช้. คีย์ API มีให้ใช้งานผ่านแพลตฟอร์มต่างๆ เช่น ตลาดภายในที่มีป้ายขาว พวกเขายังทำหน้าที่เป็นตัวระบุเฉพาะและจัดเตรียมโทเค็นลับเพื่อวัตถุประสงค์ในการตรวจสอบสิทธิ์
รหัสลับ API ใช้เพื่อระบุบัญชีของคุณ คุณจะถูกขอให้ระบุเพื่อเชื่อมต่อกับบริการบางอย่างของเรา เช่น ส่วนเสริมของ Google ชีตและฟังก์ชันการทำงานของ API คุณสามารถค้นหารหัสลับ API ของคุณได้ในหน้า API บนแดชบอร์ดของคุณ. คุณสามารถสร้างคีย์ API ใหม่ในส่วนเดียวกันได้หากจำเป็น
ขณะนี้คีย์ API ไม่มีค่าใช้จ่าย. หากคุณใช้ Cloud Endpoints เพื่อจัดการ API ของคุณ คุณอาจต้องเสียค่าบริการที่ปริมาณการรับส่งข้อมูลสูง ดูหน้าการกำหนดราคาและโควต้าปลายทางสำหรับข้อมูลเพิ่มเติม
คีย์ API เป็นโทเค็นที่ไคลเอนต์ให้เมื่อทำการเรียก API สามารถส่งคีย์ในสตริงข้อความค้นหา:รับ / อะไรซักอย่าง? api_key=abcdef12345.
- ไปที่ ไฟล์ > ใหม่ > โครงการ...
- เลือกประเภทโครงการ Visual C# จากนั้นเลือก ASP.NET Web Application (.NET Framework)
- ตั้งชื่อโครงการของคุณว่า AspNetWebApiRest แล้วคลิก ตกลง
- เลือกเทมเพลตโครงการเปล่าแล้วคลิกตกลง (ไม่ต้องทำเครื่องหมายที่ช่องใด ๆ เพื่อเพิ่มการอ้างอิงหลัก)
- ขั้นตอนที่ 1: เลือก “คีย์” จากส่วน “การจัดการระบบ”
- ขั้นตอนที่ 2: คลิกสร้าง
- ขั้นตอนที่ 3: เพิ่มนโยบายหรือ API ให้กับคีย์ของคุณ คุณมีตัวเลือกในการเพิ่มคีย์ใหม่ให้กับนโยบายที่มีอยู่หรือ API แต่ละรายการที่มีอยู่ ...
- ขั้นตอนที่ 4: เพิ่มรายละเอียดการกำหนดค่า ...
- ขั้นตอนที่ 4: คลิกสร้าง
สร้างโครงการ Web API
เริ่ม Visual Studio และเลือกโครงการใหม่จากหน้าเริ่มต้น. หรือ จากเมนูไฟล์ ให้เลือกใหม่ แล้วเลือกโครงการ ในบานหน้าต่างเทมเพลต เลือกเทมเพลตที่ติดตั้งแล้วขยายโหนด Visual C# ภายใต้ Visual C# เลือกเว็บ
จะเพิ่มคีย์ API ในคำขอ HTTP ได้อย่างไร
- เพิ่มรายการที่มีประเภท: apiKey ในส่วน global securityDefinitions ...
- ระบุว่าคีย์ API จะถูกส่งผ่านใน: header หรือใน: query
- ระบุชื่อสำหรับพารามิเตอร์หรือส่วนหัวนั้น
คีย์ API เป็นตัวระบุเฉพาะที่ใช้เชื่อมต่อหรือดำเนินการเรียก API API ย่อมาจากส่วนต่อประสานการเขียนโปรแกรมแอปพลิเคชัน API ใช้สำหรับแอปพลิเคชันซอฟต์แวร์เพื่อส่งและรับข้อมูล API ยังสามารถเชื่อมต่อโปรแกรมหนึ่งกับอีกโปรแกรมหนึ่งเพื่อแบ่งปันการทำงาน
โดยทั่วไปการพิสูจน์ตัวตนจะทำโดยกำหนดให้ไคลเอนต์ต้องระบุข้อมูลประจำตัวบางรูปแบบ เช่น ชื่อผู้ใช้และรหัสผ่าน โทเค็น OAuth หรือ JSON Web Token (JWT). ในฐานะเจ้าของ API คุณสามารถใช้การตรวจสอบสิทธิ์ใน Apigee โดยใช้นโยบาย
อย่าเก็บคีย์ API ของคุณโดยตรงในรหัสของคุณ
ให้เก็บคีย์ API และข้อมูลลับของคุณแทนโดยตรงในตัวแปรสภาพแวดล้อมของคุณ. ตัวแปรสภาพแวดล้อมเป็นวัตถุไดนามิกซึ่งมีค่าถูกตั้งค่าภายนอกแอปพลิเคชัน สิ่งนี้จะช่วยให้คุณเข้าถึงได้อย่างง่ายดาย (โดยใช้ os.
คีย์ API สามารถพบได้หลายวิธี แต่วิธีที่ง่ายที่สุดคือไปที่หน้า GitHub ของโปรแกรมที่ต้องการหรือตรวจสอบซอร์สโค้ด.
API ส่วนใหญ่ต้องการการเข้าถึงผ่านคีย์ API(คล้ายกับรหัสผ่าน) หรือวิธีการพิสูจน์ตัวตนและการอนุญาตอื่นๆ คีย์คือวิธีปกป้องผู้ให้บริการจากผู้ใช้ที่ประสงค์ร้าย และช่วยให้พวกเขาจัดการ API ได้ดีขึ้น
API อาจจำกัดเมธอดบางส่วนหรือทั้งหมดให้ต้องใช้คีย์ API. ควรทำเช่นนี้หาก: คุณต้องการปิดกั้นการรับส่งข้อมูลที่ไม่ระบุตัวตน
เพื่อให้บัญชีของคุณปลอดภัย เราขอแนะนำให้คุณอย่าแบ่งปันรหัส API ของคุณกับใคร. แทนที่จะแบ่งปันรหัสของคุณ คุณสามารถเชิญเพื่อนร่วมทีมให้เป็นส่วนหนึ่งของบัญชีองค์กรของคุณผ่านทางหน้าสมาชิก
รหัสคีย์ API จะรวมอยู่ในคำขอทั้งหมดเพื่อระบุไคลเอนต์ รหัสลับเป็นที่รู้จักเฉพาะกับไคลเอ็นต์และเกตเวย์ API.
คีย์ API มีสองประเภทหลัก:คีย์ API สาธารณะ: สิ่งเหล่านี้มักจะสร้างโดยเจ้าของแอปพลิเคชันและให้บริการแก่นักพัฒนาหรือผู้ใช้ พวกเขาอนุญาตให้นักพัฒนาเข้าถึงข้อมูลสาธารณะหรือคุณลักษณะของแอปพลิเคชัน คีย์ API ส่วนตัว: คีย์ส่วนตัวใช้ในการสื่อสารระหว่างเซิร์ฟเวอร์กับเซิร์ฟเวอร์
แหล่งที่มาของคีย์ API คืออะไร
API Gateway API ของคุณสามารถรับคีย์ API จากหนึ่งในสองแหล่งที่มา: HEADER คุณแจกจ่ายคีย์ API ให้กับลูกค้าของคุณและกำหนดให้พวกเขาส่งคีย์ API เป็นส่วนหัว X-API-Key ของคำขอที่เข้ามาแต่ละรายการ ผู้มีอำนาจ คุณมีผู้ให้สิทธิ์แลมบ์ดาส่งคืนคีย์ API โดยเป็นส่วนหนึ่งของการตอบกลับการให้สิทธิ์
REST API ใช้บริการเว็บและขึ้นอยู่กับคำขอและการตอบสนอง ในขณะที่ RESTful API ทำงานอย่างสมบูรณ์โดยอิงตามแอปพลิเคชันและโครงสร้างพื้นฐานของ REST. แอพ REST มีโปรโตคอลที่แข็งแกร่งและเลเยอร์สถาปัตยกรรมที่กำหนดค่าไว้ล่วงหน้าเป็นมาตรการรักษาความปลอดภัย ในขณะที่แอพ RESTful มีโปรโตคอลการขนส่งหลายเลเยอร์
- ใช้ HTTPS REST API ที่ปลอดภัยควรระบุปลายทาง HTTPS เท่านั้น ...
- เพิ่มการประทับเวลาให้กับคำขอ HTTP นอกเหนือจากพารามิเตอร์อื่นๆ ให้ใส่การประทับเวลาสำหรับคำขอของคุณ ...
- จำกัดวิธี HTTP ...
- พิจารณาการตรวจสอบอินพุต ...
- ใช้ OAuth ...
- อย่าเปิดเผยข้อมูลที่ละเอียดอ่อนใน URL ...
- ทำการตรวจสอบความปลอดภัย
- ก่อนอื่น ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง NodeJs และ NPM แล้ว
- สร้างชื่อโฟลเดอร์ที่คุณต้องการในตำแหน่งที่ต้องการ สำหรับตอนนี้ ฉันได้สร้างโดยใช้ชื่อ: Fake-API
- เรียกใช้ npm init ภายในโฟลเดอร์ ...
- รัน npm install — บันทึก json-server ...
- เราต้องเริ่มเซิร์ฟเวอร์ของเราตอนนี้ ...
- คุณควรเห็นไฟล์ชื่อ db
- ในการรับรายการที่เก็บคีย์-ค่าของคุณ ให้ส่งคำขอ GET ไปยังรายการปลายทางที่เก็บคีย์-ค่า ...
- หากต้องการรับข้อมูลเกี่ยวกับที่เก็บคีย์-ค่า เช่น เวลาในการสร้างและจำนวนรายการ ให้ส่งคำขอ GET ไปยังตำแหน่งข้อมูล Get store
- ค้นหา URI ของเซิร์ฟเวอร์ภายนอกหรือโปรแกรม
- เพิ่มคำกริยา HTTP
- รวมส่วนหัว
- รวมคีย์ API หรือโทเค็นการเข้าถึง
- รอการตอบกลับ
ใต้ Create Key ให้ตั้งชื่อ API เฉพาะสำหรับโครงการของคุณ จากนั้นคลิกปุ่มสร้าง. การดำเนินการนี้จะนำคุณไปยังหน้าที่แสดงรายการคีย์ที่คุณสร้างขึ้น ควรมีลักษณะเป็นสตริงสุ่ม 32 อักขระ
- เลือก GET จากดร็อปดาวน์
- พิมพ์จุดเริ่มต้นของอินสแตนซ์ API ของเรา + /users (จุดสิ้นสุด)
- กดส่ง
- ตรวจสอบรหัสสถานะที่ส่งคืนโดย API ของเรา (เราควรเห็น 200 OK )
- ดูการตอบสนองของ API ของเรา ซึ่งก็คือผู้ใช้ csv ในรูปแบบ JSON (เหมือนพจนานุกรม)
- โมฆะคงที่ Main (string[] args)
- {
- ใช้ var ลูกค้า = ใหม่ HttpClient();
- ลูกค้า. BaseAddress = URI ใหม่ (url);
- // เพิ่มส่วนหัวยอมรับสำหรับรูปแบบ JSON
- ลูกค้า. DefaultRequestHeaders. ยอมรับ. เพิ่ม(
- ใหม่ MediaTypeWithQualityHeaderValue ("แอปพลิเคชัน / json"));
- // รับการตอบสนองข้อมูล
พูดง่ายๆ ก็คือ REST APIอนุญาตให้แอปพลิเคชันโต้ตอบระหว่างกันและแลกเปลี่ยนข้อมูล. ตัวอย่างเช่น สมมติว่าคุณกำลังสร้างแอปพลิเคชันมือถือหรือเว็บแอปพลิเคชัน ในแอปพลิเคชันนั้น คุณต้องการแสดงข้อมูลสภาพอากาศ เช่น อุณหภูมิ ความชื้น ความเร็วลม เป็นต้น
รหัส API ในบุรุษไปรษณีย์คืออะไร
คีย์ API ของคุณให้การเข้าถึงข้อมูล Postman ใดๆ ที่คุณมีสิทธิ์. คุณสามารถจัดเก็บคีย์ API ของคุณในตัวแปร หากคุณตั้งชื่อว่า postman_api_key คอลเลกชัน Postman API จะใช้โดยอัตโนมัติ
หากคุณกำลังเรียกดูพอร์ทัล API สำหรับ API ที่มี URL ของ API ตั้งค่าโดยเจ้าของ API อยู่แล้ว คุณจะเห็นคำขอการเข้าถึง API ที่ด้านบนสุดของ API หาก API เป็นสาธารณะ การร้องขอการเข้าถึง API จะไม่มีผล แค่ใช้ API; มิฉะนั้น ให้คลิก ขอการเข้าถึง API และกรอกข้อมูลในกล่องโต้ตอบ.
คีย์ API รับรองความถูกต้องสำหรับ API ที่ไม่เข้าถึงข้อมูลส่วนบุคคล รหัสลูกค้ารับรองความถูกต้องด้วยบัญชี Google ของคุณ. บัญชีบริการจะตรวจสอบแอปพลิเคชันของคุณเมื่อคุณไม่ต้องการใช้ข้อมูลการเข้าสู่ระบบของบัญชีของคุณเอง (หรือบัญชีของบุคคลจริงใดๆ)
คีย์ API และโทเค็นการเข้าถึง OAuth2 เป็นทั้งสองรูปแบบของ Bearer Token.
ข้อแตกต่างที่สำคัญระหว่างการตรวจสอบสิทธิ์คีย์ API และการตรวจสอบสิทธิ์โทเค็น JWT ก็คือโทเค็น JWT นั้นอยู่ในตัวเอง - ข้อมูลที่โทเค็นยืนยันนั้นอยู่ในโทเค็นในขณะที่คีย์ API ข้อมูลที่ถูกยืนยันจะถูกจัดเก็บไว้ในระบบภายนอก
ผู้ใช้ REST API สามารถพิสูจน์ตัวตนโดยให้ ID ผู้ใช้และรหัสผ่านภายในส่วนหัว HTTP. เมื่อต้องการใช้วิธีการพิสูจน์ตัวตนนี้กับเมธอด HTTP เช่น POST, PATCH และ DELETE จะต้องระบุส่วนหัว HTTP ibm-mq-rest-csrf-token เช่นเดียวกับ ID ผู้ใช้และรหัสผ่าน
การรับรองความถูกต้องขั้นพื้นฐานเป็นวิธีการตรวจสอบสิทธิ์ที่ใช้ HTTP และเป็นวิธีที่ง่ายที่สุดในการรักษาความปลอดภัย REST API ใช้รูปแบบ Base64 เพื่อเข้ารหัสชื่อผู้ใช้และรหัสผ่าน ซึ่งทั้งสองอย่างนี้ถูกจัดเก็บไว้ในส่วนหัว HTTP
มีประโยชน์พอๆ กับ API นักพัฒนายังคงพยายามสร้างมันขึ้นมาเนื่องจากหมดอายุในเอกสารและข้อมูลจำเพาะ.
แบ่งปันคีย์ API ของคุณควรทำในสถานการณ์เฉพาะที่จำเป็นและในกรณีที่คุณไว้วางใจบุคคลหรือธุรกิจที่จะรับของเหล่านั้น. เมื่อให้สิทธิ์การเข้าถึง ให้สร้างคีย์ใหม่สำหรับไคลเอนต์แต่ละรายเสมอ เพื่อให้คุณสามารถเพิกถอนการเข้าถึงได้อย่างง่ายดายหากจำเป็น
ค่าคีย์ต้องเป็นระหว่าง 30 ถึง 128 ตัวอักษร. ค่าชื่อต้องไม่เกิน 1024 อักขระ
คีย์ API ถูกจัดเก็บอย่างไร
เก็บคีย์ APIนอกซอร์สโค้ดหรือซอร์สทรีของแอปพลิเคชันของคุณ. หากคุณใส่คีย์ API หรือข้อมูลอื่นใดในตัวแปรสภาพแวดล้อมหรือรวมไฟล์ที่จัดเก็บแยกกันแล้วแชร์รหัสของคุณ คีย์ API จะไม่รวมอยู่ในไฟล์ที่แชร์
- ใช้ส่วนขยาย Google Maps Platform API Checker Chrome ...
- หากคุณใช้ไลบรารีหรือปลั๊กอินเพื่อโหลด Maps JavaScript API ให้ตรวจสอบการตั้งค่าสำหรับไลบรารีนั้นและมองหาตัวเลือกคีย์ API
- ตรวจสอบข้อผิดพลาดในเบราว์เซอร์ของคุณ
คุณสามารถตั้งค่าการตรวจสอบคีย์ API สำหรับ API ได้โดยแนบนโยบายประเภท Verify API Key. การตั้งค่าที่จำเป็นเพียงอย่างเดียวสำหรับนโยบาย VerifyAPIKey คือตำแหน่งที่คาดไว้ของคีย์ API ในคำขอของไคลเอ็นต์ พร็อกซี API จะตรวจสอบตำแหน่งที่คุณระบุ และแยกคีย์ API
รหัส API ของคุณจะเปิดใช้งานโดยอัตโนมัติไม่เกิน 2 ชั่วโมงหลังจากการลงทะเบียนสำเร็จ. เราขอเชิญคุณอ่านเอกสาร API ที่อธิบายวิธีใช้ API ของเรา
หากต้องการค้นหา URL คำขอ API คุณจะต้องตรวจสอบเอกสาร API สำหรับ API ที่คุณสนใจ. ขึ้นอยู่กับความซับซ้อนของ API และความแข็งแกร่งของเอกสารประกอบ จุดสิ้นสุดและพารามิเตอร์ที่มีอยู่อาจค้นพบได้ง่ายมากหรือน้อย แต่ทุกสิ่งที่คุณต้องการควรอยู่ในเอกสารนั้น
เซิร์ฟเวอร์ API และ URL พื้นฐานจุดสิ้นสุด API ทั้งหมดสัมพันธ์กับ URL ฐาน. ตัวอย่างเช่น สมมติว่า URL ฐานเป็น https://api.example.com/v1 จุดสิ้นสุด /users จะอ้างอิงถึง https://api.example.com/v1/users
- เข้าสู่ระบบในส่วนลูกค้าของคุณ
- ไปที่ Developers > API credentials และเลือกชื่อผู้ใช้ API credential สำหรับการรวมระบบของคุณ เช่น ws@Company ...
- ภายใต้ การตั้งค่าเซิร์ฟเวอร์ > การรับรองความถูกต้อง เลือกแท็บคีย์ API
- เลือกสร้างคีย์ API
ที่สำคัญประกอบด้วยรหัสที่ส่งผ่านระหว่าง API และบริการแอปพลิเคชัน. โค้ดเรียกโปรแกรมจากแอปพลิเคชันอื่น จากนั้นคีย์จะระบุผู้ใช้ปลายทาง ผู้พัฒนาโค้ด และแอปพลิเคชันที่ทำการเรียก API
ตัวสร้าง API คือแอป Retool แบบฝังที่ใช้ไลบรารี่โอเพ่นซอร์สที่เราชื่นชอบ เช่น json-server, Moment js คนปลอม js และ Lodash.
จากเมนูแฮมเบอร์เกอร์ที่ด้านซ้ายบน เลือก APIs & Service > Credentials จากนั้นกด CREATE CREDENTIALS > API Keys. กล่องโต้ตอบจะปรากฏขึ้นเพื่อแสดงคีย์ API คัดลอกและจัดเก็บอย่างปลอดภัย
คีย์ API ของฉันคืออะไร
คีย์ API คือตัวระบุเฉพาะที่ตรวจสอบคำขอที่เกี่ยวข้องกับโครงการของคุณสำหรับการใช้งานและการเรียกเก็บเงิน. คุณต้องมีคีย์ API อย่างน้อยหนึ่งรายการที่เชื่อมโยงกับโครงการของคุณ
การอนุญาตโครงการ:คีย์ API จะบอก API ว่าแอปพลิเคชันที่ร้องขอมีสิทธิ์ใช้ API หรือไม่ และบริการใดของ API ที่อาจเข้าถึงได้. แม้ว่าแอปพลิเคชันจะสามารถเข้าถึง API ได้ แต่แอปพลิเคชันดังกล่าวอาจได้รับอนุญาตให้ใช้บริการของ API ได้เพียงบางส่วนเท่านั้น
- API เสาหิน API สาธารณะส่วนใหญ่เป็น API แบบ monolithic ซึ่งหมายความว่าได้รับการออกแบบให้เป็นโค้ดเบสเดียวที่เชื่อมโยงกันเพื่อให้สามารถเข้าถึงแหล่งข้อมูลที่ซับซ้อนได้ ...
- API ของไมโครเซอร์วิส ...
- API คอมโพสิต ...
- API แบบรวม
Javadocเป็นเครื่องมือสำหรับสร้างเอกสาร API ในรูปแบบ HTML จากความคิดเห็นของเอกสารในซอร์สโค้ด
- ค้นหา URI ของเซิร์ฟเวอร์ภายนอกหรือโปรแกรม
- เพิ่มคำกริยา HTTP
- รวมส่วนหัว
- รวมคีย์ API หรือโทเค็นการเข้าถึง
- รอการตอบกลับ
ค่าคีย์ต้องเป็นระหว่าง 30 ถึง 128 ตัวอักษร. ค่าชื่อต้องไม่เกิน 1024 อักขระ
