API Documentation

Base Url: https://api.shaku.tech

for using our services you should send requests to this url

Postman collection: Download

You can download the postman-collection-JSON file and import it to your postman, then the request samples will be available on your postman

# Authorization ( get access_token )

Url	/oauth/token
Method	POST

Headers :

Header Name	Value
Accept	application/json
Content-Type	application/json

Parameters :

Name	Type	Required	Description
grant_type	string	Yes	in this case you should pass the grant_type by type "password"
client_id	string	Yes	first you need to create an application in your dashboard then you should pass your client_id here
client_secret	string	Yes	at first you need to create an application in your dashboard then you should pass your client_secret here
username	string	Yes	pass your email
password	string	Yes	pass your password

Success Response :

Key	Value
token_type	Bearer
expires_in	seconds
access_token	your access token
refresh_token	you can use this token for refreshing token after expiration token time

Error Response :

Key	Value
ok	false
message	description about error
status_code	401

# Authorization ( refresh token )

Url	/oauth/token
Method	POST

Headers :

Header Name	Value
Accept	application/json
Content-Type	application/json

Parameters :

Name	Type	Required	Description
grant_type	string	Yes	in this case you should pass the grant_type by type "refresh_token"
refresh_token	string	Yes	pass your refresh_token
client_id	string	Yes	pass your client_id here
client_secret	string	Yes	pass your client_secret here

Success Response :

Key	Value
token_type	Bearer
expires_in	seconds
access_token	your access token
refresh_token	you can use this token for refreshing token after expiration token time

Error Response :

Key	Value
ok	false
message	description about error
status_code	401

# Authorization ( revoke token )

Url	/auth/revoke
Method	GET

Headers :

Header Name	Value
Accept	application/json
Authorization	Bearer "ACCESS_TOKEN"

Parameters :

no params

Success Response :

Key	Value
ok	true
data	[]
status_code	200

Error Response :

Key	Value
ok	false
message	description about error
status_code	401

# Body Measurement

Url	/api/v1/services/bodyMeasurement
Method	POST

Headers :

Header Name	Value
Accept	application/json
Authorization	Bearer "ACCESS_TOKEN"

Parameters :

Name	Type	Required	Description
present_height	string or integer	Yes	pass height
img_full_view_body	string (base64)	Yes	pass image in base64 format
img_side_view_body	string (base64)	Yes	pass image in base64 format

Success Response :

Key	Value
ok	true
data	result
status_code	200

Error Response :

Key	Value
ok	false
message	description about error

# Clothes Recognition (Auto tagging)

Url	/api/v1/services/autoTagging
Method	POST

Headers :

Header Name	Value
Accept	application/json
Authorization	Bearer "ACCESS_TOKEN"

Parameters :

Name	Type	Required	Description
image	string (base64)	Yes	pass image in base64 format

Success Response :

Key	Value
ok	true
data	result
status_code	200

Error Response :

Key	Value
ok	false
message	description about error
status_code	error code

# Garment Measurement

Url	/api/v1/services/garmentMeasurement
Method	POST

Headers :

Header Name	Value
Accept	application/json
Authorization	Bearer "ACCESS_TOKEN"

Parameters :

Name	Type	Required	Description
Image	string (base64)	Yes	pass image in base64 format

Success Response :

Key	Value
ok	true
data	result
status_code	200

Error Response :

Key	Value
ok	false
message	description about error