omidfa123 / starter

Atramart Api Documentation

User

• Create

  • URL: /api/v1/auth/register #f03c15
  • Method: POST
  • Params
    • mobile
      • validation ( required|numeric|regex:/(09)[0-9][0-9]/|digits:11|unique )
  • Error Response
    • mobile is required
    • mobile is numeric
    • mobile format invalid
    • mobile number invalid
    • mobile is unique
  • Success Response
    • status => success
    • message => successfully send verify code
    • code => sms send code

• Login

  • URL: /api/v1/auth/login
  • Method: POST
  • type static
    • Params
      • type
        • value (static)
        • validation ( required|string )
      • mobile
        • validation ( required|numeric|regex:/(09)[0-9]{9}/|digits:11 )
      • password
        • validation ( required|string|confirmed|min:8)
    • Error Response
      • mobile is required
      • mobile is numeric
      • mobile format invalid
      • mobile number invalid
      • mobile is unique
      • password is required
      • password min 8 characters
      • mobile is required
    • Exeption Error
      • status => error
      • message => exeption errors
    • Success Response
      • status => success
      • message' => Login successful
      • token_type' => bearer
      • access_token' => token
      • user => user data
  • type verify
    • mode verify
      • Params
        • mode
          • value (verify)
          • validation ( required|string )
        • mobile
          • validation ( required|numeric|regex:/(09)[0-9]{9}/|digits:11 )
      • Error Response
        • mobile is required
        • mobile is numeric
        • mobile format invalid
        • mobile number invalid
        • or
        • status => false
        • message => Invalid verify code
      • Exeption Error
        • status => error
        • message => exeption errors
      • Success Response
        • status => success
        • message' => Login successful
        • token_type' => bearer
        • access_token' => token
        • user => user data
        • type => exist or new

• Update

  • URL: /api/v1/user/user
  • Method: PATCH/PUT
  • Params
    • id
    • mobile
      • validation ( required|numeric|regex:/(09)[0-9][0-9]/|digits:11|unique )
    • first_name
      • validation ( required|string )
    • last_name
      • validation ( required|string )
    • telephone
      • validation ( required|numeric|regex:/^0[0-9]{2,}[0-9]{7,}$/|digits:11|unique:users,telephone )
    • gender
      • validation ( required )
    • national_code
      • validation ( required )
    • password and password_confirmation
      • validation ( required|string|confirmed|min:8)
    • use_password
      • true or false
      • validation ( required|string|confirmed|min:8 )
  • Error Response
    • 'mail.regex => email is invalid
    • email.unique => email is unique,
    • first_name.required => first name is required
    • last_name.required => last name is required
    • telephone.required => telephone is required
    • national_code.required => national code is required
  • Success Response
    • status => update
    • message => User successfully update
    • user => user info

• Get

  • URL: /api/v1/user/user
  • Method: GET
  • Params
    • id
  • Success Response
    • status => success
    • message => Get successfully detail
    • user =>
      • detail
      • address
      • orders
      • wishlist
      • comments
      • wallet history

Address

• Create

  • URL: /api/v1/user/address
  • Method: POST
  • Params
    • name
      • validation ( required)
    • mobile
      • validation ( required|numeric|regex:/(09)[0-9]{9}/|digits:11 )
    • telephone
      • validation ( required|numeric|regex:/^0[0-9]{2,}[0-9]{7,}$/|digits:11 )
    • post_code
      • validation (required|numeric|regex:/^[0-9]{11}$/|digits:11)
    • is_default
      • 1 value set in default address
    • street
      • validation (required)
    • city_id
      • validation (required)
    • user_id
      • validation ( required)
  • Error Response
    • status => error,
    • message => Invalid validation Inputs,
  • Success Response
    • status => success
    • message' => Address successfully created
    • address => Address collection

• Update

  • URL: /api/v1/user/address/id
  • Method: PATCH/PUT
  • Params
    • name
      • validation ( required)
    • mobile
      • validation ( required|numeric|regex:/(09)[0-9]{9}/|digits:11 )
    • telephone
      • validation ( required|numeric|regex:/^0[0-9]{2,}[0-9]{7,}$/|digits:11 )
    • post_code
      • validation (required|numeric|regex:/^[0-9]{11}$/|digits:11)
    • is_default
      • 1 value set in default address
    • street
      • validation (required)
    • city_id
      • validation (required)
    • user_id
      • validation ( required)
  • Error Response
    • status => error,
    • message => Invalid validation Inputs,
  • Success Response
    • status => update
    • message' => Address successfully created
    • address => Address collection

• Delete

  • URL: /api/v1/user/address/id
  • Method: DELETE
  • Success Response
    • status => success
    • message => Address successfully remove
    • address => Address Collection | empty

Countries

• Region and cities

  • URL: /api/v1/country/regions
  • Method: GET
  • Error Response
    • status => error,
    • message => exeption,
  • Success Response
    • status => success
    • regions => region and city child list

Categories And Menus

• Categories

  • URL: v1/catalog/categories
  • Method: POST
  • Error Response
    • status => "exeption",
    • message => exeption,
  • Exeption Error
    • status => error
    • message => exeption errors
  • Success Response
    • status => success
    • categories => category collection
    • menus => menu collection

• [Category Detail]

  • URL: v1/catalog/categories/detail
  • Method: POST
  • Params
    • id
      • validation ( required|numeric)
  • Error Response
    • id is required
    • id is numeric
  • Exeption Error
    • status => error
    • message => exeption errors
  • Success Response
    • status => success
    • attributes => attribute filter collection
    • detail => category detail
    • banner => category banner detail
    • slider => category slider detail