Sertifika Merkezi API v1.0 Dokümantasyonu
Giriş
Bu doküman, Sertifika Merkezi Web API’nin çalışma prensiplerini anlatmaktadır.
Sertifika Merkezi Web API, bir RESTful web servisidir. Sertifika Merkezi ile kendi uygulamalarını entegre etmek isteyen firma veya yazılımcılar, bu dokümanı baz alarak API’yi kullanabilirler. API kullanımı için, Sertifika Merkezine üye olunması gerekmektedir. Üyelik bilgisi olan kullanıcı api için gerekli bilgilere 'Ayarlar' sekmesinden ulaşabilir.
Genel Bilgiler
Sertifika Merkezi Web API kullanabilmek için sistem üzerinde aktif bir hesabınızın olması gerekmektedir. 'Ayarlar' başlığı altında WebAPI Token değerinin her istekte bize iletilmesi gerekmektedir.
WebAPI Token değeri header da 'Authorization : xxxxxxxxx' şeklinde gönderilmelidir.
Bazı Web API isteklerinde 'companyID' değerine ihtiyaç vardır. Bu değere 'Ayarlar' sekmesi altından ulaşılabilir.
ÖNEMLİ : userCode değerimiz email'in md5 ile şifrelenmiş halidir.
Sertifika Oluşturma Adımları
1. Şirkete ait sertifika şablonları çekilir ve ilgili sertifika şablonunun Id si alınır.
2. Sertifika detayına ulaşılır. ( Sertifika şablon verilerini çekme)
3. Gerekli Model Post atılır. (Kullanıcıya sertifika oluştur(Sertifika basma))
Şirket
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Ayarlar > companyID |
Call
api/v1.0/company/{id}/certificate
Response
[ { certificateName: "Advancity Test Sertifikası" id: "64c9f080-2314-4f02-a43c-923d83e8e444" }, { certificateName: "Advancity Test Sertifikası 1" id: "64c9f080-2314-4f02-a43c-923d83e8e555" } ]
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Ayarlar > companyID |
Call
api/v1.0/company/{id}/user/
Response
[ { name: "John" surname: "Doe" email: "john.doe@example.com" }, { name: "Jhon 1" surname: "Doe 1" email: "john1.doe1@example.com" } ]
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Ayarlar > companyID |
userCode | Yes | string | Email in MD5 ile şifrelenmiş hali |
Call
api/v1.0/company/{id}/user/{userCode}
Response
[ { name: "John" surname: "Doe" email: "john.doe@example.com" } ]
Kullanıcı
Parameter | Required | Type | Description |
---|---|---|---|
userCode | Yes | string | Email in MD5 ile şifrelenmiş hali |
Call
api/v1.0/user/{userCode}/certificate
Response
[ { certificateName: "Advancity Test Sertifikası" companyName: "Dummy Company" isPrivate: false connectionId: "04335e89-c46e-4310-b41a-923d83e8e444" }, { certificateName: "Advancity Test Sertifikası 1" companyName: "Dummy Company" isPrivate: false connectionId: "2398fac7-717c-4dae-9b6a-923d83e8e555" } ]
Sertifika
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Sertifika Id (Şirkete ait sertifikalar da id değeri mevcut) |
Call
api/v1.0/certificate/{id}
Response
{ certificateItem: [ { id:64c9f080-2314-4f02-a43c-923d83e8e444, name:null, surname:null, email:null, duration:null, grade:null, educator:null, sendEmail:True, isInUse:1, Properties: [ { "key":"alias_1434977880189", "value":"title_1434977880189" }, { "key":"alias_1434977884195", "value":"title_1434977884195" } ], metaTag: [ { "value":null } ] } ] }
NOT
name,surname,email zorunlu alanlardır. Properties alanında değişiklik yapılacak alan sadece 'value' değeridir. key alanı değiştirilmemelidir. metaTag list halinde birden fazla değerden oluşabilir.
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Sertifika Id (Şirkete ait sertifikalar da id değeri mevcut) |
Call
api/v1.0/certificate/{id}/user
Response
[ { certificateName: "Advancity Test Sertifikası" connectionId: "64c9f080-2314-4f02-a43c-923d83e8e444" name: "Jhon" surname: "Doe" email: "john.doe@example.com" id: "304e93e1-dd95-437a-adc8-dbb6350d04db" createdDate: "Aug 31 2015 11:42AM" } ]
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Sertifika Id (Şirkete ait sertifikalar da id değeri mevcut) |
userCode | Yes | string | Email in MD5 ile şifrelenmiş hali |
Call
api/v1.0/certificate/{id}/user/{userCode}
Response
{ certificateName: "C# Eğitim Sertifikası" connectionId: "1b8bf215-4182-421c-8387-58e6d72cd3b3" name: "Jhon" surname: "Doe" email: "john.doe@example.com" id: "304e93e1-dd95-437a-adc8-dbb6350d04db" createdDate: "Aug 31 2015 11:42AM" }
Belirtilen kullanıcılara sertifika oluşturur
Gönderilecek Model
public class CertificateObject { public List< certificateitem> certificateItem { get; set; } public class CertificateItem { [Required] public Guid id { get; set; } [Required] public string Name { get; set; } [Required] public string Surname { get; set; } [Required] public string Email { get; set; } public float? Hour { get; set; } public float? Point { get; set; } public string Educator { get; set; } [Required] public List< certificateproperties> Properties { get; set; } public List< metatag> metaTag { get; set; } } public class CertificateProperties { public string key { get; set; } public string value { get; set; } } public class MetaTag { public string value { get; set; } } public CertificateObject() { certificateItem = new List(); } }
Call
api/v1.0/certificate/
Response
{ "status":"OK", "messageList": [ "1-success-mailAddress", "2-success-mailAddress", "3-success-mailAddress", "4-success-mailAddress", "5-success-mailAddress", "Success count :5", "Error count :0" ] }
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Sertifika Id (Şirkete ait sertifikalar da id değeri mevcut) |
userCode | Yes | string | Email in MD5 ile şifrelenmiş hali |
Call
api/v1.0/certificate/{id}/user/{userCode}
Response
Başarılı ise - "userCode : '43b4121d1ce914d6a7f035d3791bec5d' is deleted" Başarısız ise - "userCode : '43b4121d1ce914d6a7f035d3791bec5d' is undefined or is deleted"
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | string | Sertifika Id (Şirkete ait sertifikalar da id değeri mevcut) |
Call
api/v1.0/certificate/{id}/user
Response
{ status: "OK" messageList: [ "email : 'hasan.cakmak@advancity.com.tr' is deleted" ] }