Sertifika kaydetme, silme, güncelleme, listeleme işlemleri için kullanılan servislerdir.

1. Get All Certificates

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yer alan credential'lar listelenir. Eğer proje adı olarak "admin" gönderilirse tüm credential'lar, proje adı gönderilirse sadece projede tanımlı credential'lar listelenir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSorgulanmak istenen projenin tam adı


Request Body: (none)

Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
        {
            "name": "test certificate",
            "certificateEnvironmentList": [
                {
                    "environmentName": "test",
                    "startDate": "2023-04-04T12:20:26Z",
                    "endDate": "2023-07-03T12:20:26Z",
                    "base64EncodedContent": "<base64 encoded pem content>",
                    "sha1Thumbprint": "6f5729a656f6e311954753839361da4992ff864a",
                    "subjectDn": "CN=user, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=Unknown",
                    "alias": "user"
                }
            ]
        } 
    ],
    "resultCount": 1
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


2. Create Certificate

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yeni bir sertifika oluşturulması sağlanır. Eğer proje adı olarak "admin" gönderilirse sertifika globale tanımlanır. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/

HTTP Method: POST

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Content-Type

multipart/form-data

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSertifikanın bulunduğu projenin tam adı


Request Body: (none)


Request Form Parametreleri: 

ParametreTipZorunlulukAçıklama
certificateNamestringZorunluSertifika için benzersiz isim
aliasstringZorunluSertifika için kullanılacak alias
certificateDescriptionstringİsteğe bağlıSertifikanın açıklaması
deploybooleanZorunluSertifikanın hemen deploy edilip edilmeyeceği
environmentListstringKoşulluEğer deploy seçeneği true gönderilmiş ise bu alan zorunludur, virgülle ayrılmış ortam listesi (örn: test,prod)
pemEncodedFilefileZorunluPEM formatında sertifika dosyası


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


3. Update Certificate

Açıklama/Amaç: Parametre olarak ismi gönderilen projede mevcut olan sertifikanın güncellenmesi sağlanır. Eğer proje adı olarak "admin" gönderilirse sertifika globalde güncellenir. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: PUT

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Content-Type

multipart/form-data

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSertifikanın bulunduğu projenin tam adı
certificateNameGüncellenecek olan sertifikanın tam adı


Request Body: (none)


Request Form Parametreleri: 

ParametreTipZorunlulukAçıklama
certificateNamestringZorunluSertifika için benzersiz isim
aliasstringZorunluSertifika için kullanılacak alias
certificateDescriptionstringİsteğe bağlıSertifikanın açıklaması
deploybooleanZorunluSertifikanın hemen deploy edilip edilmeyeceği
environmentListstringKoşulluEğer deploy seçeneği true gönderilmiş ise bu alan zorunludur, virgülle ayrılmış ortam listesi (örn: test,prod)
pemEncodedFilefileZorunluPEM formatında sertifika dosyası


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


4. Delete Certificate

Açıklama/Amaç: Parametre olarak ismi gönderilen projede mevcut olan sertifikanın silinmesini sağlanır. Eğer proje adı olarak "admin" gönderilirse sertifika globalden silinir. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: DELETE

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSertifikanın bulunduğu projenin tam adı
certificateNameGüncellenecek olan sertifikanın tam adı


Request Body: (none)


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


5. Get an existing Certificate 

Açıklama/Amaç: Parametre olarak ismi gönderilen projede mevcut olan sertifikanın bilgilerinin getirilmesi sağlanır. Eğer proje adı olarak "admin" gönderilirse sertifika globalden getirilir. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSertifikanın bulunduğu projenin tam adı
certificateNameGüncellenecek olan sertifikanın tam adı


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
        {
            "name": "swagger sertificate",
            "description": "swagger sertificate description",
            "certificateEnvironmentList": [
                {
                    "environmentName": "test",
                    "startDate": "2023-01-25T00:00:00Z",
                    "endDate": "2024-02-24T23:59:59Z",
                    "base64EncodedContent": " =",
                    "sha1Thumbprint": "38138BE1D2E0DDC7B8C48F0C5E5F2767F527AEC7",
                    "subjectDn": "CN=*.swagger.io",
                    "alias": "alias123456789"
                }
            ]
        }
    ],
    "resultCount": 1
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


6. Export an existing Certificate 

Açıklama/Amaç: Parametre olarak ismi gönderilen projede mevcut olan sertifikanın export edilmesi sağlanır. Eğer proje adı olarak "admin" gönderilirse sertifika globalden getirilir. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/certificates/{certificateName}/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSertifikanın bulunduğu projenin tam adı
certificateNameGüncellenecek olan sertifikanın tam adı


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

.cer uzantılı dosya ziplenmiş dosya döner. Dosya olarak kaydedilip unzip edilerek kullanılabilir. 

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


7. Get Certificates of Truststore of Environment 

Açıklama/Amaç: Parametre olarak ismi gönderilen ortamda yer alan Java'nın kullandığı tüm sertifikaların bilgilerinin dönülmesi sağlanır. 

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/admin/certificates/truststore/{environmentName}/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

environmentNameTruststore'un yer aldığı ortam


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
        {
            "alias": "alias",
            "serialNumber": "3cda1dfa47300aa6ea2407fad25009c",
            "issuer": "CN=Amazon RSA 2048 M02,O=Amazon,C=US",
            "subject": "CN=*.swagger.io",
            "validFrom": "2023-12-27T00:00:00Z",
            "validUntil": "2025-01-25T23:59:59Z",
            "publicKeyInfo": "Sun RSA public key, 2048 bits\n  params: null\n  modulus:  \n  public exponent: 65537",
            "subjectAlternativeNames": [
                "*.swagger.io"
            ],
            "signatureAlgorithm": "SHA256withRSA",
            "pathLengthConstraint": -1,
            "extendedKeyUsages": [
                "1.3.6.1.5.5.7.3.1",
                "1.3.6.1.5.5.7.3.2"
            ],
            "subjectAlternativeNamesStr": "*.swagger.io",
            "extendedKeyUsagesStr": "1.3.6.1.5.5.7.3.1,1.3.6.1.5.5.7.3.2",
            "searchObject": true,
            "valid": true
        } ,
        {
            "alias": "ou=go_daddy_class_2_certification_authority,o=the_go_daddy_group__inc.,c=us",
            "serialNumber": "0",
            "issuer": "OU=Go Daddy Class 2 Certification Authority,O=The Go Daddy Group\\, Inc.,C=US",
            "subject": "OU=Go Daddy Class 2 Certification Authority,O=The Go Daddy Group\\, Inc.,C=US",
            "validFrom": "2004-06-29T17:06:20Z",
            "validUntil": "2034-06-29T17:06:20Z",
            "publicKeyInfo": "Sun RSA public key, 2048 bits\n  params: null\n  modulus:  \n  public exponent: 3",
            "signatureAlgorithm": "SHA1withRSA",
            "pathLengthConstraint": 2147483647,
            "searchObject": true,
            "valid": true
        },
        {
            "alias": "ou=security_communication_rootca2,o=secom_trust_systems_co._ltd.,c=jp",
            "serialNumber": "0",
            "issuer": "OU=Security Communication RootCA2,O=SECOM Trust Systems CO.\\,LTD.,C=JP",
            "subject": "OU=Security Communication RootCA2,O=SECOM Trust Systems CO.\\,LTD.,C=JP",
            "validFrom": "2009-05-29T05:00:39Z",
            "validUntil": "2029-05-29T05:00:39Z",
            "publicKeyInfo": "Sun RSA public key, 2048 bits\n  params: null\n  modulus:  \n  public exponent: 65537",
            "signatureAlgorithm": "SHA256withRSA",
            "pathLengthConstraint": 2147483647,
            "searchObject": true,
            "valid": true
        } ,
        ...
    ],
    "resultCount": 153
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}