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

1. Get All API Proxy Groups for Specified Project

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yer alan API Proxy Group'ların listelenmesini sağlar.

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

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

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	İşlem yapılacak API Proxy Group'un bulunduğu projenin tam adı

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "API Proxy Group Name", "relativePath": "/relative_path", "relativePathEnabled": true, "directAccessToApiProxiesDisabled": true, "applySettingsToApiProxies": true } ], "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 API Proxy Group

Açıklama/Amaç: Belirtilen ayarlar ile yeni bir API Proxy Group oluşturulmasını sağlar.

API Proxy Group'un 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 Proxy Groups" yetkisine sahip olan bir rolünün olması gereklidir.

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

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	İşlem yapılacak API Proxy Group'un bulunduğu projenin tam adı

Request Body:

{
  "name": "api proxy group name",
  "description": "api proxy group description",
  "relativePath": "/relative_path",
  "relativePathEnabled": true,
  "directAccessToApiProxiesDisabled": false,
  "applySettingsToApiProxies": true
}

JS

Alan	Açıklama
name	API Proxy Group'un adı değeridir.
description	API Proxy Group'un açıklama değeridir.
relativePath	API Proxy Group'un relative path değeridir.
relativePathEnabled	API Proxy Group'un relative path değeri üzerinden erişim olup olmayacağını gösterir. Değeri true ise relativePath değeri üzerinden erişilebilir.
directAccessToApiProxiesDisabled	API Proxy Group içerisinde yer alan API Proxy'lere doğrudan erişim yapılıp yapılamayacağını ifade eder. Değeri true ise API Proxy'lere doğrudan erişilemez.
applySettingsToApiProxies	API Proxy Group içerisinde yer alan API Proxy'lere doğrudan erişim olduğunda API Proxy Group ayarlarının/politikalarının uygulanıp uygulanmayacağını ifade eder. Değeri true ise bu ayarların uygulanacağı anlamına gelir.

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 API Proxy Group

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy Group'un belirtilen ayarlar ile güncellenmesini sağlar.

API Proxy Group'un 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 Proxy Groups" yetkisine sahip olan bir rolünün olması gereklidir.

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

HTTP Method: UPDATE

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	İşlem yapılacak API Proxy Group'un bulunduğu projenin tam adı

Request Body:

{
  "name": "api proxy group name",
  "description": "api proxy group description",
  "relativePath": "/relative_path",
  "relativePathEnabled": true,
  "directAccessToApiProxiesDisabled": false,
  "applySettingsToApiProxies": true
}

JS

Alan	Açıklama
name	API Proxy Group'un adı değeridir.
description	API Proxy Group'un açıklama değeridir.
relativePath	API Proxy Group'un relative path değeridir.
relativePathEnabled	API Proxy Group'un relative path değeri üzerinden erişim olup olmayacağını gösterir. Değeri true ise relativePath değeri üzerinden erişilebilir.
directAccessToApiProxiesDisabled	API Proxy Group içerisinde yer alan API Proxy'lere doğrudan erişim yapılıp yapılamayacağını ifade eder. Değeri true ise API Proxy'lere doğrudan erişilemez.
applySettingsToApiProxies	API Proxy Group içerisinde yer alan API Proxy'lere doğrudan erişim olduğunda API Proxy Group ayarlarının/politikalarının uygulanıp uygulanmayacağını ifade eder. Değeri true ise bu ayarların uygulanacağı anlamına gelir.

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. Delete API Proxy Group

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy Group'un 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 Proxy Groups" ve "Deploy/Undeploy Proxies" yetkisine sahip olan bir rolünün olması gereklidir.

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

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 Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un 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": "..." }

5. Add ApiProxy to API Proxy Group

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy Group'a parametre olarak ismi gönderilen API Proxy'nin eklenmesini sağlar.

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

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

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 Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un tam adıdır.
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	{ "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. Remove ApiProxy from API Proxy Group

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy Group'dan parametre olarak ismi gönderilen API Proxy'nin silinmesini sağlar.

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

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/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	İşlem yapılacak API Proxy Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un tam adıdır.
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	{ "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. Get All Environments of API Proxy Group

Açıklama/Amaç: Parametre olarak gönderilen isme sahip olan API Proxy Group'un ortamlardaki durumunun listelenmesini sağlar.

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

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments

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	İşlem yapılacak API Proxy Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un tam adıdır.

Request Body: (none)

Response:

Status	Status Code	Description	Body
Başarılı	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "Prod Environment", "accessUrl": "https://demo.apinizer.com", "deployed": false, "redeployRequired": 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": "..." }

8. Deploy API Proxy Group to the Environment

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

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

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/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 Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un 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. Undeploy API Proxy Group from the Environment

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

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

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/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 Group'un bulunduğu projenin tam adı
apiProxyGroupName	İşlem yapılacak API Proxy Group'un 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": "..." }