11/10/2018, 10:47

Tài liệu API

Tài liệu huơng dẫn sử dụng API

1.1. Check version:

Kiểm tra phiên bản hiện tại có phải là mới nhất hay không.

get: http://localhost1001/api/api_check_version.php?version=1.4&type=ios&app=appuser

version: phiên bản trên app

type: thiết bị bạn đang dùng

app: appuser

response: 

{
status: 200,
urlApp: "",
message: "Bạn đang sử dụng version mới nhất!"
}

1.2: Đăng nhập

get: http://localhost1001/api/api_user_dang_nhap.php?type=login&username=01675627448&password=123456

type: login

username: là SĐT khách hàng.

password: mật khẩu đăng nhập

response: 

{
status: 200,
adm_id: 168272,  // == use_id là id của khách hàng
adm_name: "01675627448",
adm_fullname: "",
last_login: "11-10-2018 09:22:20",
use_gmail: "",
use_phone: "01675627448",
token: "MDE2NzU2Mjc0NDg=.MTEtMTAtMjAxOCAwOToyMjoyMA==.MTY4Mjcy"
}

1.3: Get thông tin bến.

Trả về thông tin các bến sử dụng đẻ map dữ liệu giữ 2 điểm để tính tiền.

get: http://localhost1001/api/api_user_ben.php?token=MDE2NzU2Mjc0NDg%3D.MTEtMTAtMjAxOCAwOToyNDo0OA%3D%3D.MTY4Mjcy&use_id=168272&type=home

token: get từ kết quả trả về từ api đăng nhập

use_id: là use id của khách hàng. 

type: home

VD: Response

"dataBxNew": {"ha-noi": {"name": "Hà Nội","data": {"1": "Mỹ Đình","2": "Gia Lâm","4": "Nước Ngầm","5": "Yên Nghĩa","6": "Bến xe Sơn Tây","24": "Cẩm Khê","33": "386 Phạm Văn Đồng","34": "Ngã 3 Kim Anh - Sóc Sơn","50": "SB Nội Bài","52": "Công viên Cầu Giấy"}},"tp-ho-chi-minh": {"name": "TP Hồ Chí Minh","data": {"51": "SB Tân Sơn Nhất","55": "VP Mai Chí Thọ","60": "VP Hàng Xanh"}}

}


1.4: Lấy những chuyến đi nổi bật nhất.

Hiển thi 6 chuyến đi nổi bật nhất để hiển thị ở trang Home.

get: http://localhost1001/api/user_v1/api_get_list_chuyen.php?token=MDE2NzU2Mjc0NDg%3D.MTEtMTAtMjAxOCAwOToyNDo0OA%3D%3D.MTY4Mjcy&user_id=168272

token: get từ kết quả trả về từ api đăng nhập

use_id: là use id của khách hàng. 

VD:  Response:

  • tuy_id"1",
  • tuy_ten"Mỹ Đình - Lào Cai",
  • tuy_ben_a"1",
  • tuy_ben_b"47",
  • price_thuong230000,
  • price_vip250000,
  • price_royal350000
 
 

1.5: Lấy những bài viết tin tức.

get: http://localhost1001/api/api_user_news.php?type=0

VD: Response

"new_id": "19","new_cat_id": "0","new_cat_pa_id": "0","new_title": "BÙNG NỔ NIỀM VUI CÙNG HÀNG NGÀN PHẦN QUÀ ĐÃ ĐƯỢC TRAO TỚI TAY SINH VIÊN ","new_intro": "","new_views": "286","new_time": "18-09-2017","new_avatar": "http://hasonhaivan.com//pictures/picsmalls/2017/09/18/140/dabsy1505708848.png"

 

1.6: hiển thị chi tiết một bài viết;

get: http://localhost1001/api/api_user_get_content.php?newsId=19

newsId:  là id của bài viết lấy từ đầu ra của api 1.5

 

1.7: Lấy thông tin sơ đồ giường những chuyến đi.

get: http://localhost1001/api/api_user_so_do_giuong.php?token=MDE2NzU2Mjc0NDg%3D%E2%80%A6To0MzoxOA%3D%3D.MTY4Mjcy&use_id=168272&day=11-10-2018&diem_a=1&diem_b=9

token: get từ kết quả trả về từ api đăng nhập

use_id: là use id của khách hàng. 

day: ngày mình thơi tác

diem_a: ID của điểm đi đầu.

diem_b: ID của điểm đi cuối

Response: 

https://prnt.sc/l4odkd

 

1.8: lấy thông tin chi tiết các ghế trên xe

get: http://localhost1001/api/api_adm_so_do_giuong.php?token=MDE2NzU2Mjc0NDg=.MTEtMTAtMjAxOCAwOTo1MDoyOQ==.MTY4Mjcy&adm_id=168272&not_id=61&day=11-10-2018&diem_a=1&diem_b=9

 

token: get từ kết quả trả về từ api đăng nhập

use_id =adm_id: là use id của khách hàng. 

day: ngày mình thơi tác

not_id: Là id  duy nhất lây từ API 1.7

diem_a: ID của điểm đi đầu.

diem_b: ID của điểm đi cuối

Response: 

https://prnt.sc/l4oe31

1. 9: Lấy color hạng ghế, Dùng khi cấu hình giá vé linh hoạt.

Trả về màu để hiển thị từng hạng ghế theo phần giá vé linh hoạt ( ít được app dụng)

get: http://localhost1001/api/user_v1/get_list_color_hang_ghe.php?token=MDE2NzU2Mjc0NDg=.MTEtMTAtMjAxOCAwOTo1MDoyOQ==.MTY4Mjcy&user_id=168272&did_id=14339&diem_a=1&diem_b=9&sdg_id=8

 

token: get từ kết quả trả về từ api đăng nhập

use_id: là use id của khách hàng. 

day: ngày mình thơi tác

did_id: Là id duy nhất lây từ API 1.7

sdg_id: Là ID của loại sơ đồ giường lấy từ trường sdgct_sdg_id của api 1.8

diem_a: ID của điểm đi đầu.

diem_b: ID của điểm đi cuối

 

1.10 Check một vé khi book đã được sử dụng hay chưa.

get: http://localhost1001/api/api_check_ve.php?token=MDE2NzU2Mjc0NDg=.MTEtMTAtMjAxOCAxMDoxMjowMA==.MTY4Mjcy&adm_id=168272&numberGiuong=12&bvv_id=18825

token: get từ kết quả trả về từ api đăng nhập

use_id =adm_id : là use id của khách hàng. 

numberGiuong: vị trí của ghế trên sdt giường.

bvv_id: là ID của vé mà khách khàng book

 

1.11: Get giảm giá trẻ em.

Xử lý lấy số tiền của giảm giá trẻ em.

get: http://localhost1001/api/user_v1/get_giam_gia_tre_em.php?token=MDE2NzU2Mjc0NDg=.MTEtMTAtMjAxOCAxMDoxMjowMA==.MTY4Mjcy&user_id=168272&did_id=14339&diem_di=1&diem_den=9&bvv_id=18825

token: get từ kết quả trả về từ api đăng nhập

use_id =adm_id : là use id của khách hàng. 

did_id: Là id duy nhất lây từ API 1.7

bvv_id: là ID của vé mà khách khàng book

diem_di: ID của điểm đi đầu.

diem_den: ID của điểm đi cuối

Response: 

{

  • status200,
  • mes"",
  • price_discount140000

}

 

1.12 Lấy thông giảm giá theo mã giảm giá.

Lấy số tiền giảm giá của mãi giảm giá.

get: http://localhost1001/api/user_v1/get_ma_giam_gia_detail.php?token=MDE2NzU2M%E2%80%A6272&did_id=14339&diem_di=1&diem_den=9&bvv_id=18825&giam_gia_text=abc

token: get từ kết quả trả về từ api đăng nhập

use_id =adm_id : là use id của khách hàng. 

did_id: Là id duy nhất lây từ API 1.7

bvv_id: là ID của vé mà khách khàng book

diem_di: ID của điểm đi đầu.

diem_den: ID của điểm đi cuối

giam_gia_text: ma giảm gia

1.13 Cập nhật thông tin book vé

get: http://localhost1001/api/api_user_save_order.php?token=MDE2NzU2Mjc0NDg%3D.MTEtMTAtMjAxOCAxMDozNDoyNA%3D%3D.MTQ2MTU1&type=insert&did_id=217088&user_id=146155&gio_xuat_ben=11-10-2018%2022%3A30&dataBook=%5B%7B%22labelFull%22%3A%22E2-5%22%2C%22numberGiuong%22%3A44%2C%22bvv_bex_id_a%22%3A1%2C%22bvv_bex_id_b%22%3A47%2C%22bvv_price_ly_thuyet%22%3A230000%2C%22bvv_price_discount%22%3A0%2C%22hinh_thuc_KM%22%3A0%2C%22code_KM%22%3A%22%22%2C%22key_KM%22%3A%22%22%2C%22name_KM%22%3A%22%22%2C%22bvv_id%22%3A3887409%7D%5D&address=&ghi_chu=It%20test%20app%20user%20a%2Fc%20hu%E1%BB%B7%20v%C3%A9%20h%E1%BB%99&diem_di=1&diem_den=47

 

user_id

token

diem_di

diem_den

did_id

gio_xuat_ben

dataBook:  là kiểu dữ liệu json data vé ( numberGiuong,hinh_thuc_KM, code_KM, bvv_id)

address

ghi_chu

bvv_phone_di (Thêm mới )

bvv_ten_khach_hang_di (Thêm mới )

bvv_email_di ( A Sơn bảo không cần, chỉ cần lưu thông tin sdt người đi)

bvv_ghi_chu_id (A Sơn bảo không cần, chỉ cần lưu thông tin sdt người đi )

 

1.14 trả về list thông tin xe  ( API mới

 

get: http://localhost1001/api/user_v1/api_user_get_list_xe.php?token=MDE2NzU2Mjc0NDg%3D.MTItMTAtMjAxOCAxMToyNDo1NA%3D%3D.MTY4Mjcy&user_id=168272l&did_id=14643

user_id

token

did_id

Response:

 

{

  • status200,
  • mes"Thành công!",
  • infoXe
     
    {
    • xe_id"62",
    • xe_bien_kiem_soat"24B00511",
    • xe_bien_kiem_soat_so"2400511",
    • xe_so_cho"44",
    • xe_nam_san_xuat"2015",
    • arrAttribute
       
      [
      •  
        {
        • xa_name"thuộc tính 11"
        },
      •  
        {
        • xa_name"Thuộc tính 2"
        }
      ]
    }

}

Bài liên quan

Tài liệu API

Tài liệu huơng dẫn sử dụng API

Điệp Bắp viết 1 tuần trước

Viết tài liệu cho Restfull API

Giờ đây những ứng dụng theo mô hình restfull api đang thực sự phát triển, nhưng có rất nhiều dự án lại không có một tài liệu rõ ràng để bên mobile và server có thể giao tiếp được với nhau một cách thuận tiện nhất, tôi đã chứng kiến nhiều dự án phải dùng đến excel để quản lý ...

Hoàng Hải Đăng viết 3 tuần trước

lord/slate Tài liệu để viết API đơn giản và dễ sử dụng

Hôm nay mình xin giới thiệu 1 tài liệu để viết docs api cực kỳ đơn giản. Chắc hẳn các bạn làm bên Server đã quá quen thuộc với API tuy nhiên để giao tiếp mượt mà giữa client và server thì rõ ràng phải có 1 tài liệu nằm ở giữa. Khi dự án của bạn chạy song hành thì việc viết docs rất quan trọng. Bạn ...

Trịnh Tiến Mạnh viết 18:21 ngày 12/08/2018

Viết tài liệu cho Restful API

Giờ đây những ứng dụng theo mô hình restfull api đang thực sự phát triển, nhưng có rất nhiều dự án lại không có một tài liệu rõ ràng để bên mobile và server có thể giao tiếp được với nhau một cách thuận tiện nhất, tôi đã chứng kiến nhiều dự án phải dùng đến excel để quản lý những api và tôi cũng là ...

Tạ Quốc Bảo viết 14:11 ngày 12/08/2018

Làm thế nào để kiểm tra tài liệu đặc tả yêu cầu của phần mềm (SRS)?

Bài viết được tham khảo từ nguồn: http://www.softwaretestinghelp.com/how-to-test-software-requirements-specification-srs/ Bài trước tôi đã nêu ra định nghĩa về tài liệu đặc tả yêu cầu, tôi nhắc lại để các bạn tiện theo dõi. Tài liệu đặc tả yêu cầu là những yêu cầu chính thức về những gì cần ...

Hoàng Hải Đăng viết 13:50 ngày 12/08/2018
0