Buzzebees SDK Document สารบัญ
ที่อยู่
รายการข้อมูลที่อยู่ของผู้ใช้งาน และข้อมูลที่อยู่ทั้งหมดในประเทศไทย โดยสามารถดึงข้อมูลได้จากรหัสไปรษณีย์ จังหวัด อำเภอ และตำบลต่างๆ
ข้อมูลที่อยู่ในประเทศไทย
การดึงข้อมูลที่อยู่จากรหัสไปรษณีย์ เป็น flow ที่ต้องการให้ผู้ใช้งานกรอกรหัสไปรษณีย์ก่อน และใส่ข้อมูลจังหวัด อำเภอ ตำบลให้อัตโนมัติ สามารถเรียกได้จาก API Zip Code
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/main/postcode?zip_code=10400'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {App-Id} '
ค่าที่ได้จะเป็นรายการของจังหวัดและ อำเภอที่ใช้เลขรหัสไปรษณีย์ตามที่เรียกใช้
ตัวอย่างการเลือกตำบล ภายใต้รหัสไปรษณีย์ 10400
ข้อมูลที่ได้ จะต้องนำไปจัดเป็นกลุ่มของจังหวัด อำเภอ และตำบล เพื่อนำไปใช้เป็นตัวเลือกของอำเภอ และจังหวัดดังตัวอย่างด้านบน
รายการจังหวัด
ข้อมูลรายการจังหวัดทั้งหมดในประเทศไทย สามารถดึงข้อมูลได้จาก API Get Province List
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/main/province?'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {App-Id} '
หลังจากดึงข้อมูลมาแล้วจะได้เป็น array ของแต่ล่ะจังหวัด โดยมี province_code เป็นคีย์สำคัญในการใช้ดึงข้อมูล
รายการอำเภอ
คือข้อมูลรายการอำเภอทั้งหมดภายใต้จังหวัด ซึ่งสามารถเรียกใช้งานได้จาก API Get District List โดยส่งข้อมูลพารามิติเตอร์ province_code ที่ได้จากการเรียก API Get Province List
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/main/district?province_code=10'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {App-Id} '
รายการตำบล
คือข้อมูลรายการตำบลทั้งหมด ที่อยู่ในจังหวัด และอำเภอนั้นๆ ซึ่งสามารถเรียกใช้งานและดูข้อมูลเพิ่มเติมได้จาก API Get Subdistrict List ด้วยการส่งพารามิเตอร์ province_code และ district_code ที่ต้องการ
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/main/subdistrict?province_code=10&district_code=1030&'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {App-Id} '
รายการที่อยู่
รายการที่อยู่ทั้งหมดของผู้ใช้งาน และที่อยู่ ที่ผู้ใช้งานเลือกใช้สำหรับการจัดส่งของรางวัลสำหรับแคมเปญประเภทมีการจัดส่งของรางวัล โดยสามารถเรียกใช้ได้จาก API Get Address List เพื่อนำรายการมาแสดงดังรูป
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/profile/me/addresses?'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
เพิ่ม/แก้ไข ที่อยู่
การเพิ่ม และแก้ไขข้อมูลที่อยู่ของผู้ใช้งาน ด้วยการเรียกใช้งาน API Add/Update Address โดยพารามิเตอร์จะต้องส่ง zipcode province_code district_code subdistrict_code จะได้มาจาก API Zip Code
ถ้าต้องการแก้ไขข้อมูลที่มีอยู่แล้ว ให้ทำการส่ง key เพิ่มในพารามิเตอร์ไปด้วย
curl --location --request POST 'https://buzzebees-dev.azure-api.net/api/address/profile/me/address'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
--form 'key=""'
--form 'addressname=""'
--form 'firstname=""'
--form 'lastname=""'
--form 'contact_number=""'
--form 'address=""'
--form 'zipcode=""'
--form 'province_name=""'
--form 'district_name=""'
--form 'subdistrict_name=""'
--form 'province_code=""'
--form 'district_code=""'
--form 'subdistrict_code=""'
--form 'isdefault="true"'
รายละเอียดที่อยู่
คือ รายละเอียดที่อยู่ของแต่ละรายการของผู้ใช้งาน สามารถเรียกใช้ได้จาก API Get Address Detail
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/profile/me/address?key={key}'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
ลบข้อมูลที่อยู่
คือ การลบรายการข้อมูลที่อยู่ของผู้ใช้งานแต่ละ รายการด้วยการส่ง key ไปที่ API Delete Address
curl --location --request DELETE 'https://buzzebees-dev.azure-api.net/api/address/profile/me/address?key={key}'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
รายการที่อยู่ใบกำกับภาษี
คือ รายการข้อมูลที่อยู่ใบกำกับภาษีของผู้ใช้งานทั้งหมด ที่ต้องการออกใบกำกับภาษี ซึ่งสามารถเรียกได้จาก API Get Tax List
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/profile/me/taxes?'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
เพิ่ม/แก้ไข ที่อยู่ใบกำกับภาษี
เป็นการเพิ่ม ข้อมูลที่อยู่ใบกำกับภาษีของผู้ใช้งาน สามารถเรียกใช้ได้จาก API Add/Update Tax Address List แต่ถ้าต้องการแก้ไขข้อมูลจำเป็นจะต้องส่งพารามิเตอร์ key เพิ่มเข้าไปด้วย
curl --location --request POST 'https://buzzebees-dev.azure-api.net/api/address/profile/me/tax'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
--form 'key=""'
--form 'addressname=""'
--form 'firstname=""'
--form 'lastname=""'
--form 'contact_number=""'
--form 'address=""'
--form 'zipcode=""'
--form 'province_name=""'
--form 'district_name=""'
--form 'subdistrict_name=""'
--form 'province_code=""'
--form 'district_code=""'
--form 'subdistrict_code=""'
--form 'isdefault=""'
--form 'isdefaulttax=""'
--form 'isTax=""'
--form 'taxid=""'
--form 'taxname=""'
รายละเอียดใบกำกับภาษี
คือ รายละเอียดที่อยู่ใบกำกับภาษีของแต่ละรายการของผู้ใช้งาน สามารถเรียกใช้ได้จาก API Get Tax Address
curl --location --request GET 'https://buzzebees-dev.azure-api.net/api/address/profile/me/tax?key={key}'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'
ลบที่อยู่ใบกำกับภาษี
คือ การลบรายการข้อมูลที่อยู่ใบกำกับภาษีของผู้ใช้งานแต่ละ รายการด้วยการส่ง key ไปที่ API Delete Tax Address
curl --location --request DELETE 'https://buzzebees-dev.azure-api.net/api/address/profile/me/tax?key={key}'
--header 'Content-Type: application/x-www-form-urlencoded; charset=utf-8'
--header 'Ocp-Apim-Subscription-Key: {Subscription-Key}'
--header 'Ocp-Apim-Trace: 1 '
--header 'App-Id: {app-id} '
--header 'Authorization: token {token}'