API Entegrasyonu

Entegrasyon ön hazırlık aşaması tamamlandıktan sonra, bu aşamaya geçilmelidir.

Entegrasyon formu ile ilgili 2 adet endpoint bulunmaktadır.

Entegrasyon formuna veri gönderme
Gönderilen veriler üzerinde arama yapma
Entegrasyon formu bilgileri

Bu endpointlere istek gönderilirken, oluşturulan API anahtarının Header'da gönderilmesi gerekmektedir.

Parametre	Veri Tipi	Zorunlu	Açıklama
apiKey	string	Zorunlu	Uygulama üzerinden üretilen apiKey Header'da gönderilmelidir.

1.Entegrasyon formuna veri gönderme

Form bilgilerilerini göndermek için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

İstek Parametreleri

Parametre	Veri Tipi	Zorunlu	Açıklama
FormId	String	Zorunlu	Uygulama üzerinden alınan FormId değeridir.
IsoCode	String	Zorunlu	Formun hangi dilde gönderildiğini belirten alan değeridir.
CustomField	String	Zorunlu Değil	Bu alana girelen bilgi ilgili response da geri döndürülür. Örn: UserId
FormData	Array	Zorunlu	Formun gönderilmesi istenen alanlarının name ve value değerlerini içeren alandır. FieldAttributeName form üzerinde değeri alınan element'in name değeridir. ValueMember ilgili element'e ait id/key bilgisidir. DisplayMember ilgili element'e ait değer bilgisidir.
Consents	Array	Zorunlu Değildir	GovernID tarafından checkbox olarak formun içerisine eklenen ve value alan değerinin gönderilmesi beklenen alandır.

[ POST ] https://sirius.governid.com/external/forms/integration

Request Body
[
{
"formId": "da79cb9c-0dad-4865-bfc4-ef67db4bcc62",
"isoCode": "TR",
"customField" : null
"formData": [
{
"fieldAttributeName": "name",
"fieldValue": [
  {
    "displayMember": "Smith"
  }
]
},
{
"fieldAttributeName": "surname",
"fieldValue": [
  {
    "displayMember": "Novak"
  }
]
},
{
"fieldAttributeName": "email",
"fieldValue": [
  {
    "displayMember": "[email protected]"
  }
]
},
{
"fieldAttributeName": "phoneNumber",
"fieldValue": [
  {
    "displayMember": "905000000000"
  }
]
},
{
"fieldAttributeName": "phoneNumber2",
"fieldValue": [
  {
    "valueMember": "90",
    "displayMember": "5000000000"
  }
]
},
{
"fieldAttributeName": "birthDate",
"fieldValue": [
  {
    "displayMember": "2024-01-02T16:10:05.434Z"
  }
]
},
{
"fieldAttributeName": "gender",
"fieldValue": [
  {
    "valueMember": "eff68c88-0401-4902-b3e3-dc63bf921f5f",
    "displayMember": "Male"
  }
]
}
],
"consents": [
{
  "consentId": "57daede0-3c09-4cfb-97dd-47b80d680ae9"
}
]
}
]

Response

Parametre	Veri Tipi	Açıklama
RecordTransactionId	String	Bir verinin GovernId tarafındaki benzersiz unique identifier değeridir.(Bu değer müşteri tarafında tutulmalıdır.)
CustomField	String	Gönderilen customField bilgisidir. Örn: UserId.

2.Gönderilen veriler üzerinde arama yapma

Forma gönderilen verilerde arama yapmak için kullanılır.

İstek Parametreleri

Parametre	Veri Tipi	Zorunlu	Açıklama
FormId	String	Zorunlu	Uygulama üzerinden alınan FormId değeridir.
IsoCode	String	Zorunlu	Arama yapılmak istenen dil
SearchTerm	String	Zorunlu Değil	Veriler arama alanıdır. Verileri string dışında RecordTransactionId ve CustomField'a göre aranabilir.
PageNumber	String	Zorunlu	Sayfa Numarası
PageSize	String	Zorunlu	Sayfa Sayısı

[ POST ] https://sirius.governid.com/external/forms/integration/search

Request Body
{
"formId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isoCode": "TR",
"searchTerm": "Ömer",
"pageNumber": 0,
"pageSize": 10
}

Response

Parametre	Veri Tipi	Açıklama
ColumnHeaders	Array	Column Headers içinde FieldNames'ler verinin alanını temsil eder.
PersonalData	Array	PersonalData içerisinde FieldName sırasında verilerin içeriği bulunur.

3.Entegrasyon formu bilgileri

Form ait bilgileri içerir.

İstek Parametreleri

Parametre	Veri Tipi	Zorunlu	Açıklama
apiKey	string	Zorunlu	Uygulama üzerinden üretilen apiKey Header'da gönderilmelidir.
formId	string	Zorunlu	Uygulama üzerinden alınan formId alanıdır.
isoCode	string	Zorunlu	İstenilen Dilin Kodu Gönderilir.(TR-GB vb.)

Response

Parametre	Veri Tipi	Açıklama
formId	string	FormId bilgisini içerir.
formController	Array	FieldAttributeName ve fieldName alanını içerir.
disclosureLegalText	object	Aydınlatma metninin başlığını ve içeriğini içerir.
consentLegalTexts	Array	Formun rızalarını gösterir. Rızaların id,başlık ve içeriği bulunmaktadır.Bu consentOfFormIdler forma veri gönderme işlemi yapılırken kullanıcı tarafından onaylanan rızalar Consents arrayı içinde gönderilmelidir.