Kellie Duncan
Authentication
Authentication Process
Documentations
Documentations for API
End Points
https://qa-zconnect.appinsnap.com/endpoint
Http Method
POST
Header
| Name | Type | Values | Description |
|---|
Request Parameters
| Name | Description | Required | Parameter Type | Length | Sample Value |
|---|---|---|---|---|---|
| MerchantType | MerchantType | Mandatory | String | 4 |
|
Sample Request
{
"credentials": {
"password": "passw0rd",
"site": {
"contentUrl": ""
},
"name": "administrator"
}
}
Response Parameters
| Name | Description | Parameter Type | Length | Sample Value |
|---|---|---|---|---|
| MerchantType | this is the id of the user detail. | String | 10 | "contentUrl": "" |
Response Sample
{
"credentials": {
"password": "passw0rd",
"site": {
"contentUrl": ""
},
"name": "administrator"
}
}
<?php
echo "Hi"
?>
java code
Response Code Details
{
"credentials": {
"password": "passw0rd",
"site": {
"contentUrl": ""
},
"name": "administrator"
}
}
{
"messages": "Bad Request - Invalid Access Token",
"errorcode": "4001"
}
{
"messages": "Bad Request - Invalid Request Payload",
"errorcode": "4002"
}
{
"messages": "Bad Request - Invalid Authorization Header",
"errorcode": "4003"
}
{
"messages": "Something Went Wrong",
"errorcode": "4004"
}
{
"messages": "Record Not Found",
"errorcode": "4005"
}
{
"messages": "Invalid Client Id\/Secret",
"errorcode": "4006"
}
{
"messages": "Bad Request - Invalid Access Token",
"errorcode": "4007"
}
Try out yourself
Security
X-IBM-Client-Id(apiKey located in header)
X-IBM-Client-Secret(apiKey located in header)
1c48aa28-2614-486f-aa2c-cbc86cc7ab51
1c48aa28-2614-486f-aa2c-cbc86cc7ab51
Header Parameter
| Name | Values | Description |
|---|---|---|
| Content-Type | application/json | Content Type application/json is supported |
| Accept | application/json | Content Type application/json is supported |
| organizationId | xyz | You will make a call to the auth-blb api and give it your client ID. You should add the client secret and organization ID it returns here. |
| clientId | Enter your verified Client Id | |
| clientSecret | Enter Your Verified Client Secret |
Request Body
Copy
Response Body
Copy