Proje içerisinde yer alan API Proxy'leri kaydetme, silme, güncelleme, listeleme işlemleri için kullanılan servislerdir.

1. Get All API Proxies for Specified Project

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yer alan API Proxy'ler listelenir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

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

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.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Sorgulanmak istenen projenin tam adı

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "Contact Application API", "description": "This is a sample Spring Boot RESTful service using springdoc-openapi and OpenAPI 3.", "type": "REST", "relativePath": "/contact", "soapToRest": false } ], "resultCount": 1 }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

2. Create an API Proxy from URL

Açıklama/Amaç: API Tanım dosyasının URL adresinden okunarak API Proxy oluşturulmasını sağlar.

API Proxy'nin deploy/undeploy işlemleri için deploy/undeploy uç noktası detaylarına bakınız.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir. Eğer servis oluşturulması sonrasında deploy işlemi de yapılacaksa "Deploy/Undeploy Proxies" yetkisine de sahip olunması gerekir.

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

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.
Accept	application/json
Content-Type	application/json

Request Path Parameters:

Parameter	Value
projectName	API Proxy eklenmek istenen projenin tam adı

Request Body:

{
  "apiProxyCreationType": "SWAGGER",
  "specUrl": "https://petstore.swagger.io/v2/swagger.json",
  "specAuthorizationValueList": [
    {
      "value": "string",
      "type": "string",
      "keyName": "string"
    }
  ],
  "soapToRest": false,
  "reParse": false,
  "apiProxyName": "api proxy name",
  "apiProxyDescription": "api proxy description",
  "apiProxyRelativePath": "/relative_path",
  "routingInfo": {
    "loadBalanceAlgorithm": "WEIGHTED",
    "routingAddressList": [
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      },
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      }
    ],
    "connectTimeout": "<INTEGER>",
    "readTimeout": "<INTEGER>",
    "retryCount": "<INTEGER>",
    "failoverRetryCount": "<INTEGER>",
    "ignoreRoutingError": "<BOOLEAN>"
  },
  "deploy": "<BOOLEAN>",
  "deployTargetEnvironmentNameList": [
    "<STRING>",
    "<STRING>"
  ]
 }

JS

Alan	Açıklama
apiProxyCreationType	Oluşturulacak olan API Proxy'nin referans alacağı tanım dosyasının tipini belirtir. WSDL, SWAGGER, OPEN_API, REVERSE_PROXY değerlerini alabilir.
specUrl	apiProxyCreationType değeri olarak WSDL,SWAGGER,OPEN_API değerlerinden birisi gönderilmesi durumunda tanım dosyasının adresi bu alanda yer alır. apiProxyCreationType değeri olarak REVERSE_PROXY değerinin gönderilmesi durumunda bu alan gönderilmez.
specAuthorizationValueList	specUrl adresinde yer alan tanım dosyasının ihtiyaç duyabileceği yetkilendirme bilgileri için kullanılır.
soapToRest	Eğer apiProxyCreationType değeri olarak WSDL geliyorsa (yani servis SOAP tipinde ise) ve REST olarak açılmak isteniyorsa değeri "true" olarak gönderilir ve default değerler ile bu servisin REST API Proxy olarak olarak oluşturulmasını sağlar. Zorunlu bir parametre değildir.
reParse	Mevcut bir ApiProxy tanım dosyası üzerinden tekrar oluşturulmak isteniyorsa veya farkların mevcut API Proxy'e yansıtılması isteniyorsa bu değer "true" olarak gönderilir. Zorunlu bir parametre değildir.
apiProxyName	API Proxy'nin adı değeridir. Zorunlu bir parametredir.
apiProxyDescription	API Proxy'nin açıklama değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
apiProxyRelativePath	API Proxy'nin relative path değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
routingInfo	Bu alan zorunlu değildir, ancak istek mesajıyla birlikte gönderilmesi durumunda içerdiği ayarlar Api Proxy Yönlendirmesine uygulanacaktır. Daha fazla bilgi için lütfen bu sayfaya bakın. "loadBalanceAlgorithm" alanının alabileceği değerler şunlardır: ROUND_ROBIN, LRU, WEIGHTED, RANDOM
deploy	Bu alan zorunlu değildir, ancak istek mesajı ile gönderilirse ve değeri "true" ise, API Proxy'nin oluşturma/kaydetme işleminden sonra "deployTargetEnvironmentNameList" içinde belirtilen ortamlara yükleneceği anlamına gelir.
deployTargetEnvironmentNameList	Bu alan, "deploy" alanının değeri "true" ise, Api Proxy'nin yüklenmesi gereken hedef ortamları tutar.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

3. Update an API Proxy from URL

Açıklama/Amaç: API Tanım dosyasının URL adresinden okunarak API Proxy oluşturulmasını veya varsa, özellik dosyasındaki yeni değerlerle güncellenmesini sağlar. Güncelleme işlemi, hedef özellik dosyası yeniden ayrıştırılarak(reparse) yapılır.

API Proxy'nin deploy/undeploy işlemleri için deploy/undeploy uç noktası detaylarına bakınız.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir. Eğer servis oluşturulması sonrasında deploy işlemi de yapılacaksa "Deploy/Undeploy Proxies" yetkisine de sahip olunması gerekir.

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

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.
Accept	application/json
Content-Type	application/json

Request Path Parameters:

Parameter	Value
projectName	API Proxy eklenmek istenen projenin tam adı

Request Body:

{
  "apiProxyCreationType": "SWAGGER",
  "specUrl": "https://petstore.swagger.io/v2/swagger.json",
  "specAuthorizationValueList": [
    {
      "value": "string",
      "type": "string",
      "keyName": "string"
    }
  ],
  "soapToRest": false,
  "apiProxyName": "api proxy name",
  "apiProxyDescription": "api proxy description",
  "apiProxyRelativePath": "/relative_path",
  "routingInfo": {
    "loadBalanceAlgorithm": "WEIGHTED",
    "routingAddressList": [
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      },
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      }
    ],
    "connectTimeout": "<INTEGER>",
    "readTimeout": "<INTEGER>",
    "retryCount": "<INTEGER>",
    "failoverRetryCount": "<INTEGER>",
    "ignoreRoutingError": "<BOOLEAN>"
  },
  "deploy": "<BOOLEAN>",
  "deployTargetEnvironmentNameList": [
    "<STRING>",
    "<STRING>"
  ]
 }

JS

Alan	Açıklama
apiProxyCreationType	Oluşturulacak olan API Proxy'nin referans alacağı tanım dosyasının tipini belirtir. WSDL, SWAGGER, OPEN_API, REVERSE_PROXY değerlerini alabilir.
specUrl	apiProxyCreationType değeri olarak WSDL,SWAGGER,OPEN_API değerlerinden birisi gönderilmesi durumunda tanım dosyasının adresi bu alanda yer alır. apiProxyCreationType değeri olarak REVERSE_PROXY değerinin gönderilmesi durumunda bu alan gönderilmez.
specAuthorizationValueList	specUrl adresinde yer alan tanım dosyasının ihtiyaç duyabileceği yetkilendirme bilgileri için kullanılır.
soapToRest	Eğer apiProxyCreationType değeri olarak WSDL geliyorsa (yani servis SOAP tipinde ise) ve REST olarak açılmak isteniyorsa değeri "true" olarak gönderilir ve default değerler ile bu servisin REST API Proxy olarak olarak oluşturulmasını sağlar. Zorunlu bir parametre değildir.
apiProxyName	API Proxy'nin adı değeridir. Zorunlu bir parametredir.
apiProxyDescription	API Proxy'nin açıklama değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
apiProxyRelativePath	API Proxy'nin relative path değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
routingInfo	Bu alan zorunlu değildir, ancak istek mesajıyla birlikte gönderilmesi durumunda içerdiği ayarlar Api Proxy Yönlendirmesine uygulanacaktır. Daha fazla bilgi için lütfen bu sayfaya bakın. "loadBalanceAlgorithm" alanının alabileceği değerler şunlardır: ROUND_ROBIN, LRU, WEIGHTED, RANDOM
deploy	Bu alan zorunlu değildir, ancak istek mesajı ile gönderilirse ve değeri "true" ise, API Proxy'nin oluşturma/kaydetme işleminden sonra "deployTargetEnvironmentNameList" içinde belirtilen ortamlara yükleneceği anlamına gelir.
deployTargetEnvironmentNameList	Bu alan, "deploy" alanının değeri "true" ise, Api Proxy'nin yüklenmesi gereken hedef ortamları tutar.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

4. Create an API Proxy from Spec File

Açıklama/Amaç: API Tanım dosyası yüklenerek API Proxy oluşturulmasını sağlar.

API Proxy'nin deploy/undeploy işlemleri için deploy/undeploy uç noktası detaylarına bakınız.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir. Eğer servis oluşturulması sonrasında deploy işlemi de yapılacaksa "Deploy/Undeploy Proxies" yetkisine de sahip olunması gerekir.

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

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.
Accept	application/json
Content-Type	multipart/form-data

Request Path Parameters:

Parameter	Value
projectName	API Proxy eklenmek istenen projenin tam adı

Form Data Parameters:

Parameter	Value
metadata	API Proxy ayarları için gerekli meta bilgiler
specFile	Tanım dosyasının dosya olarak yüklenmiş hali. Eğer WSDL yüklenmek isteniyor ise ve WSDL içerisinde import edilen XSD'ler dosya halinde import edilmiş ise bu dosyalar birlikte ziplenerek yüklenir. (Birden Çok Schema içeren WSDL Dosyası Yükleme detayları inceleyebilirsiniz.)

Metadata Örneği:

{
  "apiProxyCreationType": "WSDL",
  "soapToRest": false,
  "reParse": false,
  "apiProxyName": "api proxy name",
  "apiProxyDescription": "api proxy description",
  "apiProxyRelativePath": "/relative_path",
  "routingInfo": {
    "loadBalanceAlgorithm": "WEIGHTED",
    "routingAddressList": [
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      },
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      }
    ],
    "connectTimeout": "<INTEGER>",
    "readTimeout": "<INTEGER>",
    "retryCount": "<INTEGER>",
    "failoverRetryCount": "<INTEGER>",
    "ignoreRoutingError": "<BOOLEAN>"
  },
  "deploy": "<BOOLEAN>",
  "deployTargetEnvironmentNameList": [
    "<STRING>",
    "<STRING>"
  ]
 }

JS

Alan	Açıklama
apiProxyCreationType	Oluşturulacak olan API Proxy'nin referans alacağı tanım dosyasının tipini belirtir. WSDL, SWAGGER, OPEN_API, REVERSE_PROXY değerlerini alabilir.
soapToRest	Eğer apiProxyCreationType değeri olarak WSDL geliyorsa (yani servis SOAP tipinde ise) ve REST olarak açılmak isteniyorsa değeri "true" olarak gönderilir ve default değerler ile bu servisin REST API Proxy olarak olarak oluşturulmasını sağlar. Zorunlu bir parametre değildir.
reParse	Mevcut bir ApiProxy tanım dosyası üzerinden tekrar oluşturulmak isteniyorsa veya farkların mevcut API Proxy'e yansıtılması isteniyorsa bu değer "true" olarak gönderilir. Zorunlu bir parametre değildir.
apiProxyName	API Proxy'nin adı değeridir. Zorunlu bir parametredir.
apiProxyDescription	API Proxy'nin açıklama değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
apiProxyRelativePath	API Proxy'nin relative path değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
routingInfo	Bu alan zorunlu değildir, ancak istek mesajıyla birlikte gönderilmesi durumunda içerdiği ayarlar Api Proxy Yönlendirmesine uygulanacaktır. Daha fazla bilgi için lütfen bu sayfaya bakın. "loadBalanceAlgorithm" alanının alabileceği değerler şunlardır: ROUND_ROBIN, LRU, WEIGHTED, RANDOM
deploy	Bu alan zorunlu değildir, ancak istek mesajı ile gönderilirse ve değeri "true" ise, API Proxy'nin oluşturma/kaydetme işleminden sonra "deployTargetEnvironmentNameList" içinde belirtilen ortamlara yükleneceği anlamına gelir.
deployTargetEnvironmentNameList	Bu alan, "deploy" alanının değeri "true" ise, Api Proxy'nin yüklenmesi gereken hedef ortamları tutar.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

5. Update an API Proxy from Spec File

Açıklama/Amaç: API Tanım dosyası yüklenerek API Proxy oluşturulmasını veya varsa, özellik dosyasındaki yeni değerlerle güncellenmesini sağlar. Güncelleme işlemi, hedef özellik dosyası yeniden ayrıştırılarak(reparse) yapılır.

API Proxy'nin deploy/undeploy işlemleri için deploy/undeploy uç noktası detaylarına bakınız.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir. Eğer servis oluşturulması sonrasında deploy işlemi de yapılacaksa "Deploy/Undeploy Proxies" yetkisine de sahip olunması gerekir.

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

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.
Accept	application/json
Content-Type	multipart/form-data

Request Path Parameters:

Parameter	Value
projectName	API Proxy eklenmek istenen projenin tam adı

Request Form Data Parameters:

Parameter	Value
metadata	API Proxy ayarları için gerekli meta bilgiler
specFile	Tanım dosyasının dosya olarak yüklenmiş hali. Eğer WSDL yüklenmek isteniyor ise ve WSDL içerisinde import edilen XSD'ler dosya halinde import edilmiş ise bu dosyalar birlikte ziplenerek yüklenir. (Zip Dosyası hazırlama sayfasından detayları inceleyebilirsiniz.)

Metadata Örneği:

{
  "apiProxyCreationType": "WSDL",
  "soapToRest": false,
  "reParse": false,
  "apiProxyName": "api proxy name",
  "apiProxyDescription": "api proxy description",
  "apiProxyRelativePath": "/relative_path",
  "routingInfo": {
    "loadBalanceAlgorithm": "WEIGHTED",
    "routingAddressList": [
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      },
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      }
    ],
    "connectTimeout": "<INTEGER>",
    "readTimeout": "<INTEGER>",
    "retryCount": "<INTEGER>",
    "failoverRetryCount": "<INTEGER>",
    "ignoreRoutingError": "<BOOLEAN>"
  },
  "deploy": "<BOOLEAN>",
  "deployTargetEnvironmentNameList": [
    "<STRING>",
    "<STRING>"
  ]
 }

JS

Alan	Açıklama
apiProxyCreationType	Oluşturulacak olan API Proxy'nin referans alacağı tanım dosyasının tipini belirtir. WSDL, SWAGGER, OPEN_API, REVERSE_PROXY değerlerini alabilir.
soapToRest	Eğer apiProxyCreationType değeri olarak WSDL geliyorsa (yani servis SOAP tipinde ise) ve REST olarak açılmak isteniyorsa değeri "true" olarak gönderilir ve default değerler ile bu servisin REST API Proxy olarak olarak oluşturulmasını sağlar. Zorunlu bir parametre değildir.
reParse	Mevcut bir ApiProxy tanım dosyası üzerinden tekrar oluşturulmak isteniyorsa veya farkların mevcut API Proxy'e yansıtılması isteniyorsa bu değer "true" olarak gönderilir. Zorunlu bir parametre değildir.
apiProxyName	API Proxy'nin adı değeridir. Zorunlu bir parametredir.
apiProxyDescription	API Proxy'nin açıklama değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
apiProxyRelativePath	API Proxy'nin relative path değeridir. API proxy ilk oluşturulurken zorunludur, eğer reparse işlemi yapılıyorsa zorunlu değildir, reparse işleminde gönderilmesi durumunda önceki değeri değiştirir.
routingInfo	Bu alan zorunlu değildir, ancak istek mesajıyla birlikte gönderilmesi durumunda içerdiği ayarlar Api Proxy Yönlendirmesine uygulanacaktır. Daha fazla bilgi için lütfen bu sayfaya bakın. "loadBalanceAlgorithm" alanının alabileceği değerler şunlardır: ROUND_ROBIN, LRU, WEIGHTED, RANDOM
deploy	Bu alan zorunlu değildir, ancak istek mesajı ile gönderilirse ve değeri "true" ise, API Proxy'nin oluşturma/kaydetme işleminden sonra "deployTargetEnvironmentNameList" içinde belirtilen ortamlara yükleneceği anlamına gelir.
deployTargetEnvironmentNameList	Bu alan, "deploy" alanının değeri "true" ise, Api Proxy'nin yüklenmesi gereken hedef ortamları tutar.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

6. Delete an API Proxy

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy'nin bulunduğu tüm ortamlardan undeploy edilmesini ve silinmesini sağlar.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" ve "Deploy/Undeploy Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

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

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.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	Silinmek istenen API Proxy'nin bulunduğu projenin tam adı
apiProxyName	Silinmek istenen API Proxy'nin tam adıdır.

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

7. Deploy API Proxy to the Environment

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy'nin belirtilen ortama deploy edilmesini sağlar.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" ve "Deploy/Undeploy Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxies/{apiProxyName}/environments/{environmentName}/

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.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	İşlem yapılacak API Proxy'nin bulunduğu projenin tam adı
apiProxyName	İşlem yapılacak API Proxy'nin tam adıdır.
environmentName	İşlem yapılacak Ortamın adı

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

8. Undeploy API Proxy to the Environment

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy'nin belirtilen ortamdan undeploy edilmesini sağlar.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" ve "Deploy/Undeploy Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxies/{apiProxyName}/environments/{environmentName}/

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.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	İşlem yapılacak API Proxy'nin bulunduğu projenin tam adı
apiProxyName	İşlem yapılacak API Proxy'nin tam adıdır.
environmentName	İşlem yapılacak Ortamın adı

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

9. Export an API Proxy

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy'nin ayarlarının zip'lenmiş JSON dosyası formatında dışa aktarımını sağlar.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxies/{apiProxyName}/export/

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.

Request Path Parameters:

Parameter	Value
projectName	İşlem yapılacak API Proxy'nin bulunduğu projenin tam adı
apiProxyName	İşlem yapılacak API Proxy'nin tam adıdır.

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	Zip dosyası
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

10. Import an API Proxy by not overriding existing one

Açıklama/Amaç: İstekte gönderilen zip'lenmiş JSON dosyası formatındaki API Proxy'nin ayarları ile birlikte belirtilen projeye aktarımını sağlar. Bu projede gönderilen isimde API Proxy yok ise dahi isim çakışması yaşanmaması için import edilen API proxy isim ve relative path'inin sonuna "-imported" eki ekler.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

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

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

Request Path Parameters:

Parameter	Value
projectName	İşlem yapılacak API Proxy'nin bulunduğu projenin tam adı

Request Form Data Parameters:

Parameter	Value
apiProxyExportFile	ZIP'lenerek export edilen JSON formatındaki konfigürasyon tanım dosyasının dosya olarak yüklenmiş hali.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }

11. Import an API Proxy by overriding existing one

Açıklama/Amaç: İstekte gönderilen zip'lenmiş JSON dosyası formatındaki API Proxy'nin ayarları ile birlikte belirtilen projeye aktarımını sağlar. Bu projede gönderilen isimde API Proxy var ise onu buradaki ayarlar ile ezer.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

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

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

Request Path Parameters:

Parameter	Value
projectName	İşlem yapılacak API Proxy'nin bulunduğu projenin tam adı

Request Form Data Parameters:

Parameter	Value
metadata	API Proxy ayarları için gerekli meta bilgiler
apiProxyExportFile	ZIP'lenerek export edilen JSON formatındaki konfigürasyon tanım dosyasının dosya olarak yüklenmiş hali.

Metadata Örneği:

{
  "routingInfo": {
    "loadBalanceAlgorithm": "WEIGHTED",
    "routingAddressList": [
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      },
      {
        "address": "<BACKEND_API_ADDRESS",
        "weight": "<LONG>"
      }
    ],
    "connectTimeout": "<INTEGER>",
    "readTimeout": "<INTEGER>",
    "retryCount": "<INTEGER>",
    "failoverRetryCount": "<INTEGER>",
    "ignoreRoutingError": "<BOOLEAN>"
  },
  "deploy": "<BOOLEAN>",
  "deployTargetEnvironmentNameList": [
    "<STRING>",
    "<STRING>"
  ]
 }

JS

Alan	Açıklama
routingInfo	Bu alan zorunlu değildir, ancak istek mesajıyla birlikte gönderilmesi durumunda içerdiği ayarlar Api Proxy Yönlendirmesine uygulanacaktır. Daha fazla bilgi için lütfen bu sayfaya bakın. "loadBalanceAlgorithm" alanının alabileceği değerler şunlardır: ROUND_ROBIN, LRU, WEIGHTED, RANDOM
deploy	Bu alan zorunlu değildir, ancak istek mesajı ile gönderilirse ve değeri "true" ise, API Proxy'nin oluşturma/kaydetme işleminden sonra "deployTargetEnvironmentNameList" içinde belirtilen ortamlara yükleneceği anlamına gelir.
deployTargetEnvironmentNameList	Bu alan, "deploy" alanının değeri "true" ise, Api Proxy'nin yüklenmesi gereken hedef ortamları tutar.

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS" }
Hatalı	400	bad request	{ "error": "...", "error_description": "..." }
Hatalı	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Hatalı	500	internal error	{ "error": "...", "error_description": "..." }