SOAP arayüzü

Şirketler için bilgiler

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) sana sağlanır. Şirket, bu verilerle arayüz üzerinden süreli bir erişim jetonu talep edebilir. Erişim jetonu, arayüz ile 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 birkaç şirketi de yönetiyorsa, erişim jetonu yalnızca yöneten şirketin CareFlex kimliği için oluşturulmalıdır. Farklı CareFlex kimliklerine ilişkin diğer tüm bildirimler, yöneten ş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
kimliğini ve (bildirimde bulunan şirketin) API jetonunu gönderirler.
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.

Arayüzün işlevleri

  • HR Olay Bildirimi: Ana Verilerle ve Ana Veriler Olmadan
  • SOAP Bağlantısı: NewIncident
  • Not: Bir istekte en fazla 100 HR olayı aktarılabilir.
  • Boş mesaj
  • SOAP Bağlantısı: NoIncident
  • Açıklama: Bu istek, mevcut ayda herhangi bir İK olayı meydana gelmemişse yapılmalıdır.

İletişim örneği

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
}

Erişim belirteci, arayüz ile iletişim kurarken taşıyıcı belirteci olarak kullanılır

POST EP2 (yukarıya bakın) SOAP
başlıklarıyla:
“Authorization: Bearer P7kmfo8HXItLLOReHq65o4%§ggg45dYhSm5ODc”
"Content-Type: text/xml;charset=UTF-8"

Boş mesaj

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:car="http://n4.de/careflex">
<soapenv:Header/>
<soapenv:Body>
<car:NoIncidentRequest>
<careflexId>09ce3580d84bf090</careflexId>
<apitoken>maL0HMDszA2b9PKiqCAZRGh0ZDpVjmvc</apitoken>
<createdAt>2020-08-24</createdAt>
</car:NoIncidentRequest>
</soapenv:Body>
</soapenv:Envelope>

RESPONSE
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:NoIncidentResponse xmlns:ns3="http://n4.de/careflex"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Yük örnekleri

Ana veri içeren ve içermeyen bildirim

REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://n4.de/careflex/2.0">
<soapenv:Header/>
<soapenv:Body>
<ns:NewIncidentRequest>
<careflexId>09ce3580d84bf087</careflexId>
<apitoken>88ea9396-386f-4130-bd00-1dd34e5636bd</apitoken>
<incidentList>
<plainIncident>
<employeeId>4711</employeeId>
<validFrom>2020-04-24</validFrom>
<createdAt>2020-04-24</createdAt>
<type>RST</type>
</plainIncident>
<neuIncident>
<employeeId>4811</employeeId>
<validFrom>2020-04-24</validFrom>
<createdAt>2020-04-24</createdAt>
<type>NEU</type>
<employee>
<title>Prof. Dr.</title>
<firstName>Thomas</firstName>
<lastName>Mustermann</lastName>
<birthday>1979-01-15</birthday>
<sex>m</sex>
<address>
<street>Musterstraße</street>
<houseNumber>9</houseNumber>
<addressSuffix>c/o Max Hauptmieter</addressSuffix>
<zipCode>01234</zipCode>
<city>Musterstadt</city>
<country>DE</country>
</address>
<job>
<employmentSite>Şube 1</employmentSite>
<employmentStatus>T</employmentStatus>
<startOfEmployment>2020-04-24</startOfEmployment>
<personnelNumber>123654789</personnelNumber>
<management>true</management>
</job>
<contact>
<emailBusiness>
thomas.mustermann@musterfirma.de
</emailBusiness>
<mobileBusiness>0123 12345678</mobileBusiness>
<landlineBusiness>030 12345678</landlineBusiness>
</contact>
</employee>
</neuIncident>
<plainIncident>
<externalId>MüşteriKimliği-4711-2345</externalId>
<employeeId>35801170498</employeeId>
<validFrom>2020-04-24</validFrom>
<createdAt>2020-04-24</createdAt>
<type>RST</type>
</plainIncident>
</incidentList>
</ns:NewIncidentRequest>
</soapenv:Body>
</soapenv:Envelope>

RESPONSE
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:NewIncidentResponse xmlns:ns3="http://n4.de/careflex/2.0">
<importId>550a80b5-de70-4078-860e-c03d75b1dc49</importId>
<incidentResponseList>
<incident>
<rowNumber>0</rowNumber>
<incidentId>
3b2d4888-a25c-4c8b-9818-aa6b428bd2de
</incidentId>
<employeeId>4711</employeeId>
<type>RSTxxx</type>
</incident>
<incident>
<rowNumber>1</rowNumber>
<incidentId>
3615b6af-e2f2-4dcf-a945-d9ad8546228b
</incidentId>
<employeeId>4811</employeeId>
<type>NEU</type>
<incidentError>
<code>422</code>
<message>Doğrulama başarısız: 'type' alanının içeriği geçersiz: geçersiz değer</message>
</incidentError>
</incident>
<incident>
<rowNumber>2</rowNumber>
<incidentId>
3b2d4888-a25c-4c8b-9818-aa6b428bd2df
</incidentId>
<externalId>MüşteriKimliği-4711-2345</externalId>
<employeeId>35801170498</employeeId>
<type>RST</type>
</incident>
</incidentResponseList>
</ns3:NewIncidentResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>