=Note=
1. API內的name跟description為內部使用
2. undefined參數為request時,不一定要填入的參數
Request
=User sign up - customer=
{
name: "customer sign up";
discription: "for pikmi user sign up";
url: "http://pikmi/user/signup/customer";
headers:{};
method: "POST";
data: {
user_name: string,
user_email: string,
user_phone: int,
is_authenticated: undefined //verify cellphone authenticated
};
params: undefined
}
Response
=User sign up - customer=
{
"data": {
"user_name": string,
"is_authenticated": bool
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=User sign in - customer=
{
name: "customer sign in";
discription: "for pikmi user sign in";
url: "http://pikmi/user/signin/customer";
headers:{};
method: "GET";
data: {
user_name: undefined,
user_email: undefined,
user_phone: int,
is_authenticated: bool //verify cellphone authenticated
};
params: undefined
}
Response
=User sign in - customer=
{
"data": {
"user_name": string,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=User deactive - customer=
{
name: "Deactive user"; // for internal use
discription: "Deactive user"; //for internal use
url: "http://pikmi/user/deactive/customer";
headers:{
token: string;
};
method: "DELETE";
data: {
user_name: string,
user_email: string,
user_phone: int,
};
params: undefined
}
Response
=User deactive - customer=
{
"data": {
"delete_success": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=User info - customer= //取得user個人資料
{
name: "Get user info"; // for internal use
discription: "Get user info"; //for internal use
url: "http://pikmi/user/info/customer";
headers:{
token: string;
};
method: "GET";
data: undefined;
params:{
user_name: string,
user_email: string,
user_phone: int,
user_credit_info: undefined,
user_credit_due_date: undefined,
user_credit_security_code: undefined
}
}
Response
=User info - customer=
{
"data": {
"user_name": string,
"user_email": string,
"user_phone": int,
"user_id": int
"user_credit_info": string,
"user_credit_due_date": string,
"user_credit_security_code": string
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=Send verify code= //寄送驗證碼
{
name: "Send verify code"; // for internal use
discription: "For cellphone authen"; //for internal use
url: "http://pikmi/verify_phone";
headers:{};
method: "GET";
data: undefined;
params:{
"user_name": string,
"user_email": string,
"user_phone": int
}
}
Response
=Send verify code=
{
"data": {
"verify_code": int
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=Sign up - photographer=
{
name: "photographer sign up";
discription: "for pikmi photographer sign up";
url: "http://pikmi/user/signup/photographer";
headers:{};
method: "POST";
data: {
"user_name": string,
"user_email": string,
"user_phone": int,
"is_authenticated": bool, //verify cellphone authenticated
"is_verify": bool // verify by Pikmi
};
params: undefined
}
Response
=Sign up - photographer=
{
"data": {
"user_name": string,
"is_authenticated": bool,
"is_verify": bool
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=User sign in - photographer=
{
name: "photographer sign in";
discription: "for pikmi photographer sign in";
url: "http://pikmi/user/signin/photographer";
headers:{};
method: "GET";
data: {
user_name: undefined,
user_email: undefined,
user_phone: int,
is_authenticated: undefined //verify cellphone authenticated
};
params: undefined
}
Response
=User sign in - photographer=
{
"data": {
"user_name": string,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=User deactive - photographer=
{
name: "Deactive photographer"; // for internal use
discription: "Deactive photographer"; //for internal use
url: "http://pikmi/user/deactive/photographer";
headers:{
token: string;
};
method: "DELETE";
data: {
user_name: string,
user_email: string,
user_phone: int,
};
params: undefined
}
Response
=User deactive - photographer=
{
"data": {
"delete_success": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=photographer skill= //攝影師註冊 -> 技能描述
{
name: "Photographer skill"; // for internal use
discription: "Photographer to describe their skill"; //for internal use
url: "http://pikmi/photographer/skill";
headers:{};
method: "POST";
data: {
"user_name": string,
"photo_experience": float, //year
"material": string,
"catagory": string
};
params: undefined
}
Response
=photographer skill=
{
"data": {
"is_submit": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=photographer ekyc= //上傳身分證
{
name: "Photographer ekyc"; // for internal use
discription: "Photographer upload ekyc"; //for internal use
url: "http://pikmi/photographer/ekyc";
headers:{};
method: "POST";
data: {
"identity_card_front": bool,
"identity_card_back": bool,
"camera_pic": int, // arr[5], limit = 5
"camera_lens": int // arr[5], limit = 5
};
params: undefined
}
Response
=photographer ekyc=
{
"data": {
"is_submit": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=photographer portfolio= //攝影師註冊 -> 作品集
{
name: "Photographer portfolio"; // for internal use
discription: "Photographer upload portfolio"; //for internal use
url: "http://pikmi/photographer/portfolio";
headers:{};
method: "POST";
data: {
"upload_portfolio": bool,
"portfolio_link": string,
"another_identity_link": string
};
params: undefined
}
Response
=photographer portfolio=
{
"data": {
"is_submit": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}
Request
=photographer verify= //攝影師註冊狀態
{
name: "Photographer verify"; // for internal use
discription: "Verify photographer by Pikmi"; //for internal use
url: "http://pikmi/photographer/verify";
headers:{};
method: "POST";
data: {
"user_name": bool,
"phone_number" int,
"photographer_verify_skill_status": int, // 註冊攝影師,0: fail, 1: pass
"photographer_verify_ekyc_status": int, // 註冊攝影師,0: fail, 1: pass
"photographer_verify_portfolio_status: int" // 註冊攝影師,0: fail, 1: pass
};
params: undefined
}
Response
=photographer verify=
{
"data": {
"is_verify": bool,
},
"status": {
"request_id": "oooxxx",
"error_code": "0", //success
"error_message": string, // if request fail
"time": "oooxxx"
}
}