Ana içeriğe geç

Simpra Quick

Giriş​

Uygulama ve Simpra Quick Backoffice kullanımları için yapılması gereken adımlar aşağıda anlatılmıştır. Herhangi bir sorunuz olması durumunda Protein ekibi ile iletişime geçebilirsiniz.

Yararlı Linkler​

Onboarding Adımları​

Simpra Quick sisteminin kullanılabilmesi için öncelikle GMU POS sisteminde işletmeye ait Enterprise, Branch ve Device tanımlarının yapılmış olması gerekmektedir. GMU POS onboarding akışı için GMU POS Onboarding Dokümantasyonunu inceleyebilirsiniz.

  1. GMU POS tarafındaki onboarding adımları tamamlandıktan sonra Simpra Quick tarafında hesap oluşturma işlemi yapılır. Protein ekibine ait Auth Server sistemi kullanılacaksa, Protein ekibi tarafından iletilecek olan veriler ile geçerli bir JWT Token alınır. Fakat kendi Auth sistemini kullananlar için, kendi ortamlarında kullanmak üzere geçerli bir JWT Token üretmeleri gerekir.

    -> POST-/integrationapi/v1/account endpointi ile hesap oluşturma adımı gerçekleştirilir.

    • İstek atılırken eklenen request body içerisinde, username ve password değerleri girilir. Burada girilen username ve password değerleri daha sonra Simpra Quick Android uygulamasına login olurken kullanılmak üzere saklanmalıdır.

    • Başarılı istek sonrasında dönen response body'de accountId değeri elde edilir. Bu değer POST-/integrationapi/v1/device endpointindeki accountId alanı için kullanılmak üzere saklanmalıdır.

Not

Sistemde Keycloak varsa AuthServerUserId null olmalıdır. Keycloak kullanmayan sistemler kendi auth servislerindeki UserId'yi (Guid olmak zounda) bu alan vasıtası ile Quick'e iletebilirler. Id tüm sistem bazında benzersiz olmalıdır. Quick, bunu kendi accountID'si olarak kullanacaktır.

Örnek request:

{
  "authServerUserId": null,
  "username": "onboardingtest@mail.com",
  "password": "Quick123*",
  "firstName": "Onboarding",
  "lastName": "Test",
  "accountOwnerId": null,
  "integrationId": null
}

  1. Hesap oluşturma adımından sonra cihaz oluşturma işlemine geçilir.

    -> POST-/integrationapi/v1/device endpointi ile cihaz oluşturma işlemi gerçekleştirilir.

    • İstek atılırken eklenen request body içerisinde, accountId ve serialNumber değerleri girilir. accountId alanına bir önceki adımda elde edilen accountId değeri girilmelidir. Bu değer Quick veritabanında oluşturulan hesabın id değerini ifade etmektedir. Böylece oluşturulacak olan cihaz, ilgili hesapla ilişkilendirilmiş olacaktır.

    • serialNumber alanına ise GMU POS onboarding adımlarında oluşturulan cihazın seri numarası girilmelidir. (İlgili dokümandaki 5. madde linkten incelenebilir.) Böylece oluşturulacak olan cihaz, GMU POS onboarding adımlarında açılan şubeye bağlı şekilde çalışacaktır.

    • POST-/integrationapi/v1/device endpointinde yer alan paymentProviderve posSystems alanlarıyla ilgili gerekli bilgiler aşağıda belirtilen endpointler aracılığıyla elde edilebilir;

      • GET-/integrationapi/v1/definitions endpointi ile paymentProviderve posSystems alanlarının id ve name bilgileri çekilir. Ek olarak, her bir paymentProvider için paymentProviderApplicationId değeri, dönen response body içerisinde providerApplications altında yer alan id değeri ile elde edilebilir.

      • GET-/integrationapi/v1/definitions/paymentprovidermeta/list endpointine ilgili paymentProviderId ve paymentProviderApplicationId verilerek dönen response'ta, cihaz oluşturulurken paymentProviderMetaConfigs altında yer alan parametrelerin ne şekilde verilmesi gerektiğiyle ilgili bilgiler elde edilir.

      • GET-/integrationapi/v1/definitions/possystemmeta/list endpointine ilgili posSystemId verilerek dönen response'ta, cihaz oluşturulurken posSystems altında yer alan konfigürasyon parametrelerinin ne şekilde verilmesi gerektiğiyle ilgili bilgiler elde edilir.

    • Yukarıdaki adımlarda elde edilen bilgilerle paymentProvider ve posSystems alanları da doldurulduktan sonra cihaz oluşturulur. Başarılı istek sonrası response olarak cihaz id'si dönülmektedir.

Örnek request:

{
   "paymentProviderId":"SimpraPay",
   "paymentProviderApplicationId": "399e7d51-0211-ef11-af94-005056bf2f5c",
   "paymentProviderConfigs":[
      {
         "paymentProviderMetaId":"17681309-eeb8-ed11-af7d-005056bf2f5c",
         "paymentProviderMetaCode":"applicationLoginId",
         "value":"info@simprasuite.com"
      },
      {
         "paymentProviderMetaId":"18681309-eeb8-ed11-af7d-005056bf2f5c",
         "paymentProviderMetaCode":"password",
         "value":"624332424Aew!fX"
      },
      {
         "paymentProviderMetaId":"19681309-eeb8-ed11-af7d-005056bf2f5c",
         "paymentProviderMetaCode":"userHash",
         "value":"fcelik"
      },
      {
         "paymentProviderMetaId":"0b9ae2f4-d4c3-ed11-af7f-005056bf2f5c",
         "paymentProviderMetaCode":"BaseURL",
         "value":"https://propaytest.protel.com.tr"
      },
      {
         "paymentProviderMetaId":"0c9ae2f4-d4c3-ed11-af7f-005056bf2f5c",
         "paymentProviderMetaCode":"BaseURLPath",
         "value":"v2"
      },
      {
         "paymentProviderMetaId":"0d9ae2f4-d4c3-ed11-af7f-005056bf2f5c",
         "paymentProviderMetaCode":"DecryptionKey",
         "value":"v3WTzsRP4cvKSaGCgVa6ckmN0lH6k9rC"
      },
      {
         "paymentProviderMetaId":"30511d88-00c4-ed11-af7f-005056bf2f5c",
         "paymentProviderMetaCode":"SoftPosUrl",
         "value":"https://www.simprasuite.com/payment"
      },
      {
         "paymentProviderMetaId":"675e0903-c48a-ee11-af8c-005056bf2f5c",
         "paymentProviderMetaCode":"SubtenantId",
         "value”:”"
      }
   ],
   "posSystems":[
      {
         "posSystemId":"GmuPos",
         "enabled":true,
         "configs":[
            {
               "posSystemMetaId":"1a681309-eeb8-ed11-af7d-005056bf2f5c",
               "posSystemMetaCode":"username",
               "value":"76459837102"
            },
            {
               "posSystemMetaId":"1b681309-eeb8-ed11-af7d-005056bf2f5c",
               "posSystemMetaCode":"password",
               "value":"2277EEFA"
            }
         ]
      }
   ],
   "accountId":"a632f7ae-18ad-44a6-81cb-d15bb00962b4",
   "serialNumber":"76459837102",
   "description":"Onboarding Test Cihazı 2",
   "slipInformation":null,
   "fields":[
      null
   ],
   "addSlipToFooter":true
}
  1. Hesap ve cihaz oluşturulup ilişkilendirildikten sonra SDK üzerinden, oluşturulan hesap bilgileri ile (1. adımda üretilen username ve password değerleri ile) login olunarak ilgili enterprise ve şube özelinde uygulama kullanılabilir.
En son tarihinde güncellendi