updateProducts
Partner can use this API to collect the latest data after they have completed at least one data collection task. The input parameter is connectionKey, which was sent to the partner when Klavi first sent the report.
During the update process, partner can also use the CheckStatus() to check the status.
It's OK not to poll actively. Anyway, when the task is completed, the result will be returned by callback.
This updateProducts API will depend on previous user credentials. However, there is always a chance that users have changed their credentials when we tried to update.
So, as soon as you receive any of the error codes related to wrong credentials, such as 402, 406, and 408, please stop calling this API, instead, ask users to connect with new credentials again. Otherwise, the wrong credentials case would stick and might cause account-blocking issues.
Request parameter: None
Body:
Name | Type | Required | Description |
|---|---|---|---|
connectionKey | String | Yes | The tracking number of the task |
Return data:
Name | Type | Description |
|---|---|---|
traceId | String | The tracking number of the task |
Request example:
curl -s -L -X POST 'https://api-testing.klavi.ai/link/external/v2/updateProducts' \
-H 'Authorization: K1-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cbms/k1_request, SignedHeaders=content-type;host, Signature=cca1508a396977d25e548bebe8fecf54d1b40c2400177dc802068d94f6b9d7bb' \
-H 'X-Timestamp: 1551113065' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Region: ap-brazil' \
--data-raw '{"connectionKey":"7d3f54f43dd54cf4ba323a2350247c55"}'
Return to the correct example:
{
"code":200,
"msg":"Solicitação realizada com sucesso",
"data":{
"traceId":"96oLr905aoJs0Qad5B0ASHgweFkIIOtZ"
}
}Examle of formatting errors:
{
"code":410,
"msg":"The user input the wrong credential (cpf)",
"data":{
}
}