дипломная работа. Даар. Разработка службы курьерской доставки в мобильном приложении

• Название: Разработка службы курьерской доставки в мобильном приложении
• Анкор: дипломная работа
• Дата: 24.04.2023
• Размер: 0.63 Mb.
• Имя файла: Даар.docx
• Тип: Реферат; #1086258
• страница: 9 из 13

4.2 API для работы с мобильными приложениями

Рисунок 7 – Иерархия классов API
API доступно по адресу: «https://api.a3technology.ru/ version / section / methodAlias» и имеет следующие методы:

Секция common.

В секции commonпредставлены универсальные методы,которые можно применить как в клиентском, так и в курьерском приложениях. Например, смена аватара.

• 
  calcCost () - Расчет цены из точки А в точку Б;
  
• 
  rate ($token= '') - Оценить заказ и оставить отзыв;
  
• 
  setAvatar ($token= '') - Загрузить аватар;
  
• 
  addOrderPhoto ($token= '') - Загрузка фото заказа;
  
• 
  addUpdateDevice () - Добавить либо обновить devicetoken.
  

Секция client

Секция clientсодержит Apiметоды для работы с клиентским приложением.

• 
  sendSmsCode () - Получить пин клиента для авторизации;
  
• 
  confirmAccountByCode () - Получить токен авторизации;
  
• 
  getProfile ($token=««) - Клиент получает данные профиля;
  
• 
  addOrder ($token=««) - Добавить заказ пользователя;
  
• 
  confirmOrder () - Подтвердить заказ;
  
• 
  getOrderStatus ($token=««) - Получить статус заказа ;
  
• 
  getCourierProfile($token=««) - Получить данные профиля курьера;
  
• 
  setProfileData ($token=««) - Изменить данные профиля;
  
• 
  geoLog ($token=««) - Записать лог местоположения клиента;
  
• 
  getOrderHistory ($token=««) - Получить count заказов клиента из истории, со сдвигом offset;
  
• 
  getAddresses ($token=««) - Получить список адресов клиента;
  
• 
  setFaveAddress ($token=««) - Добавить или удалить адрес в список избранного;
  
• 
  trackCourier ($token=««) - последняя координата курьера;
  
• 
  signup () - Зарегистрировать клиента с указанием личной информации;
  
• 
  getDeliveryOptions () - получить список активных доп. опций заказа;
  
• 
  bindCard ($token=««) - Привязать карту пользователя;
  
• 
  getBindedCards ($token=««) - Получить список привязанных пластиковых карт;
  
• 
  unbindCard ($token=««) - Удалить привязанную карту;
  
• 
  setCardAlias ($token=««) - Изменить пользовательское название карты;
  
• 
  payWithCard ($token=««) - оплатить с помощью карты;
  
• 
  rejectOrder ($token=««) - отменить заказ;
  
• 
  logout ($token=««) - выйти из текущего аккаунта;
  
• 
  getOrderData ($token=««) - Получить данные заказа.
  

Секция courier

Методы для работы с курьерским приложением.

• 
  signUpRequest () - Запрос курьера на регистрацию Номер телефона должен быть уникальным;
  
• 
  authorize () - Получить токен, данные профиля и состояния курьера по логину и паролю;
  
• 
  getProfile ($token=««) - Курьер получает данные профиля;
  
• 
  setActive ($token=««) - Управление статусом занятости курьера;
  
• 
  checkOffer ($token=««) - Проверить предложения работы для курьера;
  
• 
  choiceOrder ($token=««) - Выбрать текущий доступный заказ;
  
• 
  rejectOrder ($token=««) - Отклонить текущий доступный заказ;
  
• 
  getOrderData ($token=««) - Подробные данные о заказе;
  
• 
  setOrderState ($token=««) - Управление статусом заказа;
  
• 
  geoLog ($token=««) - Записать лог местоположения курьера;
  
• 
  getStatus ($token=««) - Получить статус курьера;
  
• 
  getOrderHistory ($token=««) - Получить count заказов курьера из истории, со сдвигом offset;
  
• 
  logout ($token=««) - выйти из текущего аккаунта;
  
• 
  restorePassword () - Получить СМС с пин-кодом восстановления пароля;
  
• 
  changePass () - Сменить пароль курьера;
  
• 
  addOrderSign () - Загрузить файл с росписью клиента на экране устройства курьера;
  
• 
  setProfileData ($token=««) - Записать лог местоположения курьера;
  
• 
  bindCard ($token=««) - Привязать карту курьера;
  
• 
  getBindedCards ($token=««) - Получить список привязанных пластиковых карт;
  
• 
  unbindCard ($token=««) - Удалить привязанную карту;
  
• 
  setCardAlias ($token=««) - Изменить пользовательское название карты;
  
• 
  getEarning ($token=««) - получить заработок курьера;
  
• 
  getOrders ($token=««) - получить список активных заказов курьера.
  

Для обращения ко всем методам необходимо использовать HTTP POST-запрос с как минимум одним параметром (токен пользователя). Все методы написаны на языке PHP.

Ниже, для наглядного примера реализации методов, приведен листинг метода получения данных о клиенте:


Рисунок 8 – Мметод получения данных о клиенте PHP
Как видно из рисунка 8, для того чтобы получить данные о пользователе, необходимо в параметрах POST запроса указать токен пользователя.

Пример этого же метода, на языке Java, со стороны клиентского мобильного Android приложения приведен на рисунке 9:



Рисунок 9 – Метод получения данных о клиенте Java