Firma Yönetimi Rest Api Geliştirici Kılavuzu (1.0.0)
Download OpenAPI specification:Download
Turkcell e-Şirket Firma Yönetimi API uç noktaları REST olarak geliştirilmiştir. API kullanımı ve entegrasyon süreçlerinize başlamadan önce mutlaka satis@eplatform.com.tr adresinden satış ekibimiz ile iletişime geçmelisiniz. Satın alma süreçlerinden sonra satış temsilcimiz entegrasyon ekibimiz ile iletişime geçecektir. Turkcell e-Şirket bünyesinde yer alan diğer uygulamaların dokümantasyonlarına https://developer.turkcellesirket.com adresinden ulaşabilirsiniz.
Servis üzerinden gönderim yapmak için arayüz üzerinden apikey oluşturmanız gerekmektedir.
Test ortamda https://portaltest.isim360.com/home/api-management adresinden apikey oluşturabilirsiniz.
Canlı ortamda https://portal.turkcellesirket.com/home/api-management adresinden apikey oluşturabilirsiniz.
ApiKey oluşturma dokümanını entegrasyon ekibimiz ile iletişime geçtiğinizde, sizlere iletecektir.
Entegrasyon çalışmalarında yaptığınız işlemlerin sonuçlarını, test portalimizi kullanarak gözlemleyebilirsiniz.
Test arayüz adresi; https://portaltest.isim360.com/
Yeni firma oluşturma
Yeni alt firma tanımlama uç noktasıdır. Burada firmaya otomatik olarak Kontor (ortak havuz) ürünü ve sunusu da tanımlanır. Eğer firma halihazırda mevcut ise yalnızca sunu tanımı yapılır. Firma ve sunusu arkaplanda asenkron şekilde oluşturulduğu için oluşacak firma bilgilerini ayriyeten daha sonra GET /v1/sharedpoolusage/report uç noktasından çekebilirsiniz. Kendisine ait ya da başka bir distribütöre bağlı aktif sunusu olan firmalara tanım yapılamaz.
Request Body schema: application/json
| identifier required | string Firma VKN/TCKN |
| name required | string Firma ünvanı |
| quantity required | integer Kontör miktarı |
| contactPersonFullName required | string Firmadaki kontak kişinin adı soyadı |
| contactPersonEmailName required | string <email> Firmadaki kontak kişinin e-posta adresi |
| contactPersonPhoneNumber required | string^5\d{9}$ Firmadaki kontak kişinin telefon numarası, 5xxxxxxxxx formatında olmalıdır |
Responses
Request samples
- Payload
{- "identifier": "34112233443",
- "name": "test",
- "quantity": 50,
- "contactPersonFullName": "İsim Soyisim",
- "contactPersonEmailName": "eposta@test.test",
- "contactPersonPhoneNumber": "5554445555"
}Firmaya kontör sunusu ekleme
Mevcut alt firmaya kontör sunusu ekleme uç noktasıdır. Firmaya Kontor (ortak havuz) ürünü ve kullanım yapabileceği kontör sunusu tanımlanır.
path Parameters
| customerUniqueId required | string <uuid> Firmanın benzersiz kimliği |
Request Body schema: application/json
| quantity required | integer Kontör miktarı |
| showOverUsage | boolean Eğer true verilirse firmanın aşım miktarı bu yeni tanımlanacak sunudan düşer |
Responses
Request samples
- Payload
{- "quantity": 80,
- "showOverUsage": false
}Birden fazla firmaya kontör sunusu ekleme
Birden fazla mevcut alt firmaya kontör sunusu ekleme uç noktasıdır. Firmalara Kontor (ortak havuz) ürünü ve kullanım yapabilecekleri kontör sunusu tanımlanır.
Request Body schema: application/json
| customerUniqueIds required | Array of strings <uuid> Firmaların benzersiz kimlikleri |
| quantity required | integer Kontör miktarı |
| showOverUsage | boolean Eğer true verilirse firmanın aşım miktarı bu yeni tanımlanacak sunudan düşer |
Responses
Request samples
- Payload
{- "customerUniqueIds": [
- "5b20cafe-58d8-4245-9ce4-2f5dc01a3913"
], - "quantity": 80,
- "showOverUsage": false
}Firmaya ürün ekleme
Mevcut alt firmaya yeni e-dönüşüm ürünü ekleme uç noktasıdır. Eğer firmanın Kontor (ortak havuz) ürünü ve sunusu bulunmuyorsa öncelikle POST /v1/crm/customers/{customerUniqueId}/addapplicationcredit veya POST /v1/crm/addbatchapplicationcredit uç noktalarından Kontor (ortak havuz) ürünü ve sunusu tanımlanmalıdır.
path Parameters
| customerUniqueId required | string <uuid> Firmanın benzersiz kimliği |
Request Body schema: application/json
| productTypes required | Array of integers (ProductType) Items Enum: 1 2 3 4 5 7 8 11 12 13 Ürün tipleri. Değerler:
|
Responses
Request samples
- Payload
{- "productTypes": [
- 2,
- 3
]
}Birden fazla firmaya ürün ekleme
Birden fazla mevcut alt firmaya yeni e-dönüşüm ürünü ekleme uç noktasıdır. Eğer firmanın Kontor (ortak havuz) ürünü ve sunusu bulunmuyorsa öncelikle POST /v1/crm/customers/{customerUniqueId}/addapplicationcredit veya POST /v1/crm/addbatchapplicationcredit uç noktalarından Kontor (ortak havuz) ürünü ve sunusu tanımlanmalıdır.
Request Body schema: application/json
| customerUniqueIds required | Array of strings <uuid> Firmaların benzersiz kimlikleri |
| productTypes required | Array of integers (ProductType) Items Enum: 1 2 3 4 5 7 8 11 12 13 Ürün tipleri. Değerler:
|
Responses
Request samples
- Payload
{- "customerUniqueIds": [
- "5b20cafe-58d8-4245-9ce4-2f5dc01a3913"
], - "productTypes": [
- 2,
- 3
]
}Kontör sunusu iptal etme
Mevcut alt firmaya ait kontör sunusunu iptal etme uç noktasıdır. Firmaların son kalan aktif kontör sunuları iptal edilemez.
path Parameters
| customerUniqueId required | string <uuid> Firmanın benzersiz kimliği |
| applicationCreditId required | integer Firmaya ait sununun benzersiz kimliği. Bkz: Rapor objesindeki credits (Credit objesi) içindeki id alanı. |