Kimlik Doğrulama
Tüm yönetici şirketler, süreli bir erişim jetonu (oAuth Bearer Token) aracılığıyla kimlik doğrulaması yapmalıdır. Bunun için, portal üzerinden ("Veri İçe Aktarma Ayarları" sekmesinde) hizmet kullanıcısına ait veriler (ID ve Secret) sağlanır. Şirket, bu verilerle arayüz üzerinden süreli bir erişim jetonu talep edebilir. Erişim jetonu, arayüzle HTTP iletişimi sırasında olay arayüzüne kimlik doğrulama başlığı içinde taşıyıcı jetonu olarak iletilmelidir.
Bir şirket, başka şirketleri de yönetiyorsa, erişim jetonu yalnızca yönetici şirketin CareFlex kimliği için oluşturulmalıdır. Farklı CareFlex kimliklerine ilişkin diğer tüm bildirimler, yönetici şirketin erişim jetonu ile bildirilir. Dolayısıyla, ana CareFlex kimliğine atanan tüm şirketleri yönetmek için yalnızca bir hizmet kullanıcısı/hizmet kullanıcısı gizli anahtarı kombinasyonu gereklidir.
Yetkilendirme
Tüm şirketler, bildirimde hem API jetonunu hem de CareFlex kimliğini iletmelidir.
Bildirimle birlikte (hak sahibi şirketin) CareFlex ID'sini ve (bildirimde bulunan şirketin) API jetonunu gönderirsiniz.
API jetonu, şirket portalında “CRM” / “Veri içe aktarma ayarları” altında oluşturulabilir. Bir şirket tarafından yönetilen tüm varlıklar için yalnızca bir API jetonu vardır.
CareFlex ID'nin API Token ile birlikte doğruluğu, mesaj gönderilirken kontrol edilmez, ancak gönderilen mesajın portala başarıyla içe aktarılmasının ardından geri bildirim işlevi aracılığıyla kontrol edilebilir.
Erişim belirteci sorgusu
POST EP1 (yukarıya bakın)
json gövdesi:
{
"grant_type":"password",
"username":"<kullanıcı_kimliği (hizmet kullanıcısı)>",
"password":"<kullanıcı_gizli_anahtarı (hizmet kullanıcısı)>"
}
ve başlıkları:
"Content-Type: application/json"
Yanıt, 12 saat boyunca geçerli olan bir erişim belirteci içerir
{
"access_token":"P7kmfo8HXItLLOReHq65o4%§ggg45dYhSm5ODc",
"token_type":"Bearer",
"expires_in":43200,
"created_at":1589887223
}
Yük örnekleri
Ana veri içeren ve içermeyen bildirim
REQUEST
{
"careflexId": "09ce3580d84bf087",
"apiToken": "maL0HMDszA2b9PKiqCAZRGh0ZDpVjmvc",
"incidentList": [
{
"externalId": "1000" ,
"type": "NEU",
"employeeId": "49239697103",
"createdAt": "2020-10-24",
"validFrom": "2020-10-24",
"employee": {
"title": "Prof. Dr.",
"firstName": "Thomas",
"lastName": "Mustermann",
"birthday": "1979-01-15",
"sex": "m",
"address": {
"street": "Musterstraße",
"houseNumber": 9,
"adresSoneki": "c/o Max Hauptmieter",
"postaKodu": "01234",
"şehir": "Musterstadt",
"ülke": “DE”
},
"iş": {
"çalışmaYeri": "Şube 1",
"çalışmaDurumu": "T",
"işeBaşlamaTarihi": "2020-04-24",
"personnelNumber": "string",
"management": false
},
"contact": {
"emailBusiness": "thomas.mustermann@musterfirma.de",
"mobileBusiness": "0123 12345678",
"iş sabit telefonu": “030 12345678”
}
}
},
{
"harici kimlik": "1234-xx",
"type": "SDB",
"createdAt": "2021-06-30",
"validFrom": "2021-07-01",
"employeeId": "12345678901",
"employee": {
"firstName": "Thomas",
"lastName": “Mustermann”
}
},
{
"type": "WIK",
"employeeId": "49239697103",
"createdAt": "2020-09-24",
"validFrom": "2020-08-24"
}
]
}
RESPONSE
{
"importId": "8d2adbc0-4d63-4cec-a8f4-445b08a3e33e",
"incidentResponseList": [
{
"rowNumber": 0,
"incidentId": "8ba8977c-a75b-4ec0-9798-7a7f14209720",
"externalId": "1000",
"employeeId": "49239697103",
"type": “NEU”
},
{
"rowNumber": 1,
"incidentId": "916aebfc-2feb-429b-8631-52703a195ad9",
"externalId": "1234-xx",
"employeeId": "12345678901",
"type": “SDB”
},
{
"rowNumber": 2,
"incidentId": "e8b77933-2a31-404c-9e23-8b547b37068f",
"externalId": null,
"employeeId": "49239697103",
"type": “WIK”
}
]
}