Kirmizi olan yerlerin degismesi gerekiyor.

Test platformu icin lutfen tum https://api.booktasker.com/ alan adlarini https://testapi.booktasker.com/ olarak degistirin

Create Bearer Token for user

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/create-token/{langCode}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
  • Body
    • username: user name
    • password: password
    • device_name: device name
    • device_brand: device brand (Apple, Android...)
    • device_model: device model (iPhone 11, GCE x86 phone...)

Get Cleaning Types - Guidelines

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/cleaning-types/{langCode}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key

Get orders

URL'deki "type" optional. Valid degerler: 'open-jobs' veya 'my-jobs'. Eger type'a bir sey yazmazsaniz Open Jobs ve My Jobs birlikte gelir.

"cleaning_start_date" istek gonderirseniz o tarihten sonraki order'lar doner.

"cleaning_end_date" istek gonderirseniz o tarihten onceki order'lar doner.

Ornegin tomorrow icin "cleaning_start_date" ve "cleaning_end_date" i yarinin tarihini gonderirseniz sadece yarinin order'lari doner.

Hic tarih gondermezseniz tum orderlar doner.

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/get-orders/{type?}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • langCode: (optional) format: string (enUk, ptPt, trTr)
    • cleaning_start_date: (optional) format: unix timestamp
    • cleaning_end_date: (optional) format: unix timestamp

Job Details

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/order-details/{order ID}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • langCode: (optional) format: string (enUk, ptPt, trTr)

Job Requests

Valid request_type values: send-request, cancel-request, cancel-this-job, im-on-my-way, start, finish, reschedule, employee-note, upload-image, delete-image, additional-hour, rate-this-job

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/order-details/{order ID}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • request_type: required
    • booking_start_timestamp: required (format: unix timestamp) if request_type is "reschedule"
    • employee_note: required if request_type is "employee-note"
    • file: required if request_type is "upload-image"
    • file_id: required if request_type is "delete-image"
    • cancelling_reason: required if request_type is "cancel-this-job"
    • additional_hour: required (format: numeric) if request_type is "additional-hour"
    • satisfied: required (format: numeric) if request_type is "rate-this-job"
    • communication: required (format: numeric) if request_type is "rate-this-job"
    • feedback: required (format: string) if request_type is "rate-this-job"

Get user details

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/get-user-details
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token

Set user details

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/set-user-details
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • email: required
    • first_name: required
    • last_name: required
    • phone: required
    • date_of_birth: (optional) format: unix timestamp
    • address_details[address_line_1]: (optional)
    • address_details[address_line_2]: (optional)
    • address_details[city]: (optional)
    • address_details[postcode]: (optional)
    • address_details[country]: (optional)
    • nationality: (optional) (value from /get-countries function)
    • working_days: (optional) (json example: ["Monday", "Thursday"] )
    • working_hours: (optional) (json example: {"Monday":{"from":"09:00","to":"15:30"},"Wednesday":{"from":"10:00","to":"17:00"}} )

Upload Profile Picture

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/upload-profile-picture
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • file: (required) (type: image)

Delete Profile Picture

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/delete-profile-picture
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token

Upload Document

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/upload-document
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • file: (required) (type: png, jpeg, jpg, pdf)

Delete Document

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/delete-document/{document-id}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token

Logout

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/logout
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token

Inactivate Account

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/inactivate-my-account
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token

Change Password

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/change-password
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
    • Authorization: Bearer bearer token
  • Body
    • current_password: current password (required)
    • password: new password (required)
    • password_confirmation: new pasword re-type (required)

Get Extras (Ironing, Inside oven...)

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/get-extras/{langCode}
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key

Get countries

  • Method: GET
  • URL: https://api.booktasker.com/api/cleaners/get-countries
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key

Get Coordinates of Address (latitude, longitude)

  • Method: POST
  • URL: https://api.booktasker.com/api/cleaners/coordinates-of-address
  • Headers
    • Accept: application/json
    • X-API-KEY: api-key
  • Body
    • address: (required) (postcode is enough)