Genelde işlem bazlı anketlerde tercih edilen yöntemdir. API'nin ne zaman tetiklenip linkin alınacağına isteği gönderen sistem karar verir. API tetiklendiği anda link oluşturulur. Anket linkinin müşteriye gönderimini isteği gönderen sistem yapar.
API kullanımından önce Pisano içerisinde Link Kanalı tanımlanmalı ve ilgili akış bağlanmalıdır.
Endpoint Bilgileri
POST https://<pisanoURL>/external/v1/link_sharings/:link_channel_id/generate_link
*** pisanoURL bilgisi Pisano tarafından sizinle paylaşılacaktır.
*** On-prem müşterileri için pisanoURL bilgisi, sistem yöneticisi tarafından API configmap (ENV) içerisinde api_host değişkenindeki bilgi ile değiştirilmelidir.
Parametreler
|
Parametre |
Değer |
|
:link_channel_id |
Link kanal id'si (aşağıda anlatılmıştır) |
|
customer |
Müşteri özel bilgi alanları ve değerleri. JSON Object |
|
built_in_responses |
Linke gömülecek geri bildirim bazlı bilgiler. JSON Object |
|
options |
Kısa link oluşturulmak isteniyorsa "true" seçilmelidir |
Başlıklar (HTTP Header)
|
Başlık |
Değer |
|
Content-Type |
application/json |
|
Authorization |
Token token=<API_TOKEN> |
Örnek cURL İsteği
curl --location 'https://<pisanoEnvironment>/external/v1/link_sharings/:link_channel_id/generate_link' \
--header 'accept: application/json' \
--header 'authorization: <token> ' \
--header 'Content-Type: application/json' \
--data-raw '{
"customer": {
"email": “<email_1>",
"external_id": "<external_id1>"
},
"built_in_responses": {
"Segment": "<Segment1>",
"Location": "<Location1>",
"TransactionDate": "<TransactionDate1>"
},
"options": {
"shorten_url": true
}
}'
Kişiselleştirilmiş link için request her müşteri bazında tek tek atılmalıdır.
# - 20 requests in 8 seconds
On premise kurulumlarda Email & SMS & Push notification &Link throttle limitleri artırılabilir veya tamamen kaldırılabilir
On premise kurulumlarda Throttle kuralları IP bazlı konfigüre edilebilir.
API id alma (link_channel_id)
- Kanallar > Link Kanallarına gidip ilgili kanalın "Düzenle" butonuna tıklayınız.
- API ID (link_channel_id) bu ekran üzerindeki url'in son değeridir. Örnek API ID:
80e41df5-49fe-475c-986c-f003a59124af
TOKEN alma - Pisano'da tüm API kullanımları için TOKEN almalısınız.
API Yanıt Kodları
Response Status Code
Status
Status Code
Message
200
OK (Successful)
400
bad_request
13000
An error occured
401
unauthorized
13001
Wrong authentication token
404
NOT_FOUND
13002
Requested resource not found!
404
not_found
13003
Reset Token not found
404
not_found
13005
This node, nor any of their parent has any flow
403
forbidden
13007
It's not allowed to update Pisano node
400
bad_request
13008
Record could not be deleted
400
bad_request
13009
Updated question already has responses
404
not_found
13010
User not found
401
unauthorized
13011
User is inactive
409
conflict
13012
Password does not match the old password
403
forbidden
13013
Permission denied
400
bad_request
13014
Wrong activation code
400
bad_request
13015
Required field not present in params!
404
not_found
13016
Token not found
400
bad_request
13017
Duplicate value
404
not_found
13018
Response not found
404
not_found
13019
Activation token not found
400
bad_request
13020
You selected a reserved node type. Please choose another one.
400
bad_request
13024
Multiple responses given for a non-multiple choice question
400
bad_request
13026
Captcha is invalid
400
bad_request
13028
Invalid parameters
400
bad_request
13029
Invalid security hash
400
bad_request
13030
Invalid authentication token
400
bad_request
13031
Invalid proxy server parameters
409
conflict
13032
Wrong credentials
400
bad_request
13033
Invalid SDK credentials
400
bad_request
13034
Invalid Flow
404
not_found
13035
Node not found
403
forbidden
13036
Account locked
400
bad_request
13037
Malformatted CSV
400
bad_request
13038
Required customer identitiy keys not present in params!