ტექნიკური დოკუმენტი

API ტექნიკური დოკუმენტი :

დოკუმენტი აღწერს Westore-ის სისტემაში ინტეგრაციის ინსტრუქციას.

რეგისტრაცია :

მერჩანტის როგორც ფიზიკური ან იურიდიული პირის რეგისტრაცია უნდა მოხდეს ვებგვერდზე შემდეგ ბმულზე (რეგისტრაცია). ასევე უნდა გაფორმდეს ხელშეკრულება და გააქტიურდეს ანგარიში Westore-ის სისტემაში შესასვლელად.

ზემოთხსენებული ინფორმაციის (საიდენტიფიკაციო/პირადი ნომერი და პაროლი) მიღების შემდგომ, შესაძლებელია ინტეგრაციის დაწყება.

API ინტეგრაცია :

ქვემოთ აღწერილი ოპერაციების ბრძანებების გაგზავნა უნდა განხორციელდეს შემდეგ მისამართზე: https://westore.ge/api/

სისტემაში შესაძლებელია შემდეგი ოპერაციების შესრულება:

  • POST /api/v1/login
  • GET /api/v1/cities
  • GET /api/v1/shippingtypes
  • GET /api/v1/products
  • GET /api/v1/quantities
  • POST /api/v1/orders
ოპეერაციების შესასრულებლად პირველ რიგში საჭიროა სისტემაში ავტორიზაცია.
ავტორიზაცია უნდა მოხდეს შემდეგი პარამეტრებით: საიდენტიფიკაციო/პირადი ნომრით და პაროლით, შესრულებული მოთხოვნა დააბრუნებს ID და Token, რომელიც შემდგომში უნდა გამოიყენოთ სხვა მოთხოვნების შესასრულებლად.
ყველა სხვა მოთხოვნას ჰედერში უნდა გამოატანოთ შემდეგი ჰედერები:
Bearer Token და საჭიროებისას ID

ავტორიზაცია:

url: /api/v1/login
მეთოდი: POST
შესაყვანი პარამეტრები:
`idnumber`, `password`
პასუხი:
`id`, `token`

მაგალითი:
პარამეტრები
idnumber: '405637565'
password: 'Password123'

პასუხი
{
`id`: 1
`token`: 'eyJhbGciOiJIUzI1NiIsInC5cCI6IkpXVCIsImlzcyI6Imp3dC5sb2NhbCIsImF1ZCI6InRva2VuQHdlc3RvcmUuZ2UifQ.eyJpZCI6IjEiLCJpZG51bWJlciI6IjQwNTMzMjY3MCIsImlzcyI6Imp3dC5sb2NhbCIsImF1ZCI6InRva2VuQHdlc3RvcmUuR2FvdsKJeHAiOjE3MTI1ODkzMTN9.q8RvbOWCGeb26HqQT1LyKG0qWl0tHKMWX2_mWaEFLjz'
}

ქალაქების ჩამონათვალი:

url: /api/v1/cities
მეთოდი: GET
პასუხი:
ქალაქების სია

მაგალითი:
პასუხი
{
"1": {
"id": "1",
"name_en": "Agara",
"name": "აგარა"
},
"2": {
"id": "2",
"name_en": "Agaraki",
"name": "აგარაკი"
},
"3": {
"id": "3",
"name_en": "Adigeni",
"name": "ადიგენი"
},
...
...
}

მიწოდების/ტრანსპორტირების ტიპი:

url: /api/v1/shippingtypes
მეთოდი: GET
პასუხი:
მიწოდების მეთოდები

მაგალითი:
პასუხი:
{
{
"id": "1",
"name": "სტანდარტული"
},
{
"id": "2",
"name": "სწრაფი"
},
{
"id": "3",
"name": "იმავე დღეს"
}
}

პროდუქციის ჩამონათვალი:

url: /api/v1/products
მეთოდი: GET
ჰედერი: { Authorization: "Bearer <თოკენი>"
} შესაყვანი პარამეტრები:
`user_id`
პასუხი:
პროდუქციის ჩამონათვალი

მაგალითი:
Url: /api/v1/products?user_id=1
ჰედერი: {
Authorization: "Bearer <თოკენი>"
}
პარამეტრები
`user_id`: 1

მაგალითი
პასუხი:
{
{
"number": "123456789", (პროდუქტის უნიკალური კოდი)
"name": "მეხსიერების ბარათი" (პროდუქტის დასახელება)
},
{
"number": "12345678911", (პროდუქტის უნიკალური კოდი)
"name": "ბურთი" (პროდუქტის დასახელება)
},
... ...
}

პროდუქციის მარაგი:

url: /api/v1/quantities
მეთოდი: GET
ჰედერი: {
Authorization: "Bearer <თოკენი>"
}
შესაყვანი პარამეტრები:
`user_id`
პასუხი:
პროდუქციის მარაგი

მაგალითი:
Url: /api/v1/quantities?user_id=1
პარამეტრები
`user_id`: 1

მაგალითი:
პასუხი:
{
{
"number": "722208569881",
"qty": "523"
},
{
"number": "722208569973",
"qty": "50"
},
{
"number": "722208570436",
"qty": "5"
},
... ...
}

შეკვეთის გაგზავნა:

url: /api/v1/orders
მეთოდი: POST
ჰედერი: {
Authorization: "Bearer <თოკენი>"
}
შესაყვანი პარამეტრები:
`user_id`,
`fullname`,
`city`,
`address`,
`phone`,
`phone2`,
`amount`,
`shipping_type`,
`shipping_id`,
`delivery_channel`,
`weight`,
`comment`,
`numbers`(უნდა იყოს მასივი),
`names`(უნდა იყოს მასივი),
`quantities`(უნდა იყოს მასივი)
პასუხი:
"შეკვეთა დამატებულია წარმატებით!"

მაგალითი:
პარამეტრები
{
`id`: 1
`fullname`: 'fullname'
`city`: 'city address'
....
}

Output
["success" => "შეკვეთა დამატებულია წარმატებით!"]

კითხვების შემთხვევაში დაგვიკავშირდით