Nykaa Add Connection Flow
- Anushi Dhaketa
- Shefali Chandak (Unlicensed)
- Rashi Mishra (Unlicensed)
- Shrikrishna Huilgol (Unlicensed)
STEPS :
Step1. Create a Public App:
Create an app on partner dashboard using API request and enter all the body parameters.
Set the intendedAudience parameter as Public and status as Active to make your app available at workspace.
https://partners.eshopbox.com/api/v1/appBody Parameters Required:
Attributes | Description |
|---|---|
title | Nykaa |
description | Fulfil Nykaa orders seamlessly |
homePageUrl | |
logoUrl | https://storage.googleapis.com/invoicefiles-staging/image/nykaalogo.png |
intendedAudience | public |
appCategory | ecommerce |
status | active |
whitelistedRedirectionUrl | |
appType | sales_channel_app |
externalPortalID | NYKK |
integrationModelCode | NYKAA |
Step2. Create a version of the app:
We need to create a version of the app. Initially it is ‘1.0.0’ and later on it is upgraded correspondingly with the modifications of the app. The version can be updated using the put API:
https://partners.myeshopbox.com/api/v1/app/{{appId}}/version/{{version}}Sample response body:
{
"id": 557,
"appId": 536,
"version": "1.0.0",
"authentication": {
"test": {
"headers": {},
"method": "GET",
"params": {
"username": "{{bundle.inputData.username}}",
"password": "{{bundle.inputData.password}}"
},
"body": {},
"removeMissingValuesFrom": {},
"url": "https://nykaauat.vinsupplier.com/RestWS/api/sellerPanel/v3/authToken"
},
"fields": [],
"oauth2Config": null,
"basicConfig": null,
"type": "basicAuth",
"connectionLabel": "{{bundle.inputData.account_slug}}",
"handleBar": "basicAuth_536",
"createdAt": "2023-05-18T13:58:48.758+0000",
"updatedAt": "2023-05-19T08:44:03.676+0000"
},
"isDeprecated": false,
"createdAt": "2023-05-18T19:28:20.000Z",
"updatedAt": "2023-05-18T19:31:22.000Z"
}To get the version of the app, we can use the get API:
https://partners.myeshopbox.com/api/v1/app/{{appId}}/version/{{version}}Headers for the above API:
Authorization : Bearer <Token>
partnerCode : <partnerCode>
The App Setup Steps:
Step3. Connect your Nykaa Store.
The authFields are fetched from frontend using the API request.
https://{{workspace}}.auperator.co/api/v1/connection/startSample Body for Nykaa:
{
"appId": 536,
"installationId": ' ',
"authFields": {
"username": "50TEST",
"password": "pass"
},
"connectionName": "test"
}Step3.1. Generate Auth Token:
Prepare the Access Token URL using username and password. Username and password are passed in params.
Sample URL:
GET 'https://xxxxx/RestWS/api/sellerPanel/v3/authToken?username=50TEST&password=pass'The Auth Token generated in response is a Token and is having a validity of 1 year.
Request Params Used During Generation of Access Token:
Key/ Intro | Value | Mandatory |
|---|---|---|
Username | 50TEST | Y |
Password | pass | Y |
Step3.2. Fetch Auth Token:
Using the above prepared URL make a HTTP GET Request to fetch Access Token.
Sample Response from Nykaa:
{
"status": "SUCCESS",
"apiKey": "NTFURVNUNH43OWUxZTY3MGY2YWE0MDUxYjQ3ZTE2ZWQxNjMyY2UzZGMyOTJhZWNkYTgyOTQ0ZDFhZWU4YTU0",
"apiOwner": "51TEST4"
}Step4. Choose fulfillment location: Once the app is connected choose the fulfillment location.
Step5. Build your product catalog.
Step6. Set automations.
Step7. Update and Save the Auth Token in Database:
Update the accessToken and its info in the database and Save AccessTokenExpiryAt, AccessTokenGeneratedOn along with accessToken in DataBase using the below query.
The AccessTokenGeneratedOn will be the current time when the cron hits and AccessTokenExpiryAt will be automatically updated to the date after 1 year (since, Auth Token of Nykaa has a validity of 1 year).
UPDATE `ie_appinstall_connection` SET
`accessToken` = :new_access_token,
`accessTokenExpiryAt` = :new_expiry_time,
`accessTokenGeneratedOn` = :current_time
WHERE `ie_appinstall_connection`.`id` = :connection_id;