How to Develop your own in App-Purchase Service in Odoo
Download as PPTX, PDF0 likes213 views
This document discusses how to develop an in-app purchase (IAP) service in Odoo. It describes the normal service flow as: (1) a client requests a service, (2) the service provider checks if the client has enough credits and creates a transaction, (3) the service is provided, (4) the transaction is captured or cancelled, and (5) the client is notified. It also provides details on registering a service with Odoo IAP, developing the client-side Odoo app, using IAP helpers on the service-side, and testing the IAP integration.
![➔ To make implementation easy, IAP provides a iap_jsonrpc() helper to
call a JSON-RPC2 endpoint on an IAP service side Odoo instance and
transparently re-raise related Odoo exceptions.
➔ Each transaction called over API will require client account token.
➔ The token of the current client that is provided by the iap.account
model’s account_token field. You can retrieve the account for your
service by calling env['iap.account'].get("service_name") where
"service_name" is the name of the service registered under IAP
Account.](https://image.slidesharecdn.com/howtodevelopyourownin-app-purchaseserviceinodoo-201102094025/85/How-to-Develop-your-own-in-App-Purchase-Service-in-Odoo-18-320.jpg)
![Odoo IAP Helpers
iap.tools.iap_tools.iap_capture
➔ JSON-RPC2 wrapper to call service
json endpoint implemented using
Odoo IAP Services
➔ iap_jsonrpc() takes care of re-raising
InsufficientCreditError for you.
from odoo.addons.iap.tools import iap_tools
def fetch_cur_rate(self):
user_token = self.env['iap.account'].get('live_cur_ex_rate')
service_endpoint =
self.env['ir.config_parameter'].sudo().get_param('live_cur_ex_rate.endpoint',
self._default_live_cur_ex_rate)
for move in self:
if move.company_currency_id == move.currency_id:
raise UserError(_('Invoice currency and company currency is same, '
'this document do not require exchange rates.'))
params = {
'user_token': user_token.account_token,
'request_res_id': '%s,%s'%(move._name, move.id),
'from_cur': move.company_currency_id.name,
'to_cur': move.currency_id.name,
}
response = iap_tools.iap_jsonrpc(service_endpoint + '/curex/v1/convert',
params=params)
result = response.get('result', 0)
if not result:
raise UserError(_('Could not get the result please try again later. '
'No credit was consumed for this request.'))
move.write({
'iap_curex_rate': result,
'iap_curex_rate_dt': fields.Datetime.now(),
})
credit = self.env['iap.account'].get_credits('live_cur_ex_rate')
credit_url = self.env['iap.account'].get_credits_url('live_cur_ex_rate')
return {'type': 'ir.actions.act_window_close'}](https://image.slidesharecdn.com/howtodevelopyourownin-app-purchaseserviceinodoo-201102094025/85/How-to-Develop-your-own-in-App-Purchase-Service-in-Odoo-19-320.jpg)
Ad
More Related Content
What's hot (20)
Similar to How to Develop your own in App-Purchase Service in Odoo (20)
Ad
More from Odoo (20)
Ad
Recently uploaded (20)
How to Develop your own in App-Purchase Service in Odoo
- 2. How to Develop your own In-App-Purchase (IAP) Service in Odoo?
- 3. In-app purchasing refers to the buying of services from inside an application.
- 4. The Normal Service Flow 1 External Service (Third Party Service) 5 3 2 4 transaction flow Odoo IAP Service End Customers The Service Provider
- 5. The Normal Service Flow The Client requests a service of some sort. The Service Provider asks Odoo if there are enough credits for the service in the Client’s account, and creates a transaction over that amount. The Service Provider provides the service (either on their own or calling to External Services). The Service Provider goes back to Odoo to capture (if the service could be provided) or cancel (if the service could not be provided) the transaction created at step 2. Finally, the Service Provider notifies the Client that the service has been rendered, possibly (depending on the service) displaying or storing its results in the client’s system. If everything goes well, the normal flow is the following: 1 2 3 4 5
- 6. The Normal Service Flow The Client requests a service of some sort. The Service Provider asks Odoo if there are enough credits for the service in the Client’s account, and creates a transaction over that amount. The Service Provider provides the service (either on their own or calling to External Services). The Service Provider goes back to Odoo to capture (if the service could be provided) or cancel (if the service could not be provided) the transaction created at step 2. Finally, the Service Provider notifies the Client that the service has been rendered, possibly (depending on the service) displaying or storing its results in the client’s system. If everything goes well, the normal flow is the following: 1 2 3 4 5
- 7. The Normal Service Flow The Client requests a service of some sort. The Service Provider asks Odoo if there are enough credits for the service in the Client’s account, and creates a transaction over that amount. The Service Provider provides the service (either on their own or calling to External Services). The Service Provider goes back to Odoo to capture (if the service could be provided) or cancel (if the service could not be provided) the transaction created at step 2. Finally, the Service Provider notifies the Client that the service has been rendered, possibly (depending on the service) displaying or storing its results in the client’s system. If everything goes well, the normal flow is the following: 1 2 3 4 5
- 8. The Normal Service Flow The Client requests a service of some sort. The Service Provider asks Odoo if there are enough credits for the service in the Client’s account, and creates a transaction over that amount. The Service Provider provides the service (either on their own or calling to External Services). The Service Provider goes back to Odoo to capture (if the service could be provided) or cancel (if the service could not be provided) the transaction created at step 2. Finally, the Service Provider notifies the Client that the service has been rendered, possibly (depending on the service) displaying or storing its results in the client’s system. If everything goes well, the normal flow is the following: 1 2 3 4 5
- 9. The Normal Service Flow The Client requests a service of some sort. The Service Provider asks Odoo if there are enough credits for the service in the Client’s account, and creates a transaction over that amount. The Service Provider provides the service (either on their own or calling to External Services). The Service Provider goes back to Odoo to capture (if the service could be provided) or cancel (if the service could not be provided) the transaction created at step 2. Finally, the Service Provider notifies the Client that the service has been rendered, possibly (depending on the service) displaying or storing its results in the client’s system. If everything goes well, the normal flow is the following: 1 2 3 4 5
- 10. Insufficient credits Flow 1 3 2 4 External Service (Third Party Service) Odoo IAP Service End Customers The Service Provider
- 11. Building your service Registering the service with Odoo IAP
- 15. The Credits ➔ The credits went from integer to float value starting October 2018. Integer values are still supported for backward compatibilities. ➔ Every service provided through the IAP platform can be used by the clients with tokens or credits. The credits are an float unit and their monetary value depends on the service and is decided by the provider. ◆ Examples of credit and consumption: ● for a sms service : 1 credit = 1 sms ● for an ad service : 10 credit = 100 Char Ad or ● for a postage service : 1 credit = 1 post stamp. ➔ The value of the credits is fixed with the help of prepaid credit packs that the clients can buy on iap.odoo.com (see Packs).
- 16. Odoo App The Client Side Odoo App
- 17. ➔ The second step is to develop an Odoo App which clients can install in their Odoo instance and through which they can request the services you provide. ➔ First, we will create an odoo module depending on iap. IAP is a standard from V11 onwards and the dependency ensures a local account is properly set up and we will have access to some necessary views and useful helpers. ➔ Add client side business logic that will call service side API that provides the desired service. ➔ There are no specific requirement of protocol and services on service and client side.
- 18. ➔ To make implementation easy, IAP provides a iap_jsonrpc() helper to call a JSON-RPC2 endpoint on an IAP service side Odoo instance and transparently re-raise related Odoo exceptions. ➔ Each transaction called over API will require client account token. ➔ The token of the current client that is provided by the iap.account model’s account_token field. You can retrieve the account for your service by calling env['iap.account'].get("service_name") where "service_name" is the name of the service registered under IAP Account.
- 19. Odoo IAP Helpers iap.tools.iap_tools.iap_capture ➔ JSON-RPC2 wrapper to call service json endpoint implemented using Odoo IAP Services ➔ iap_jsonrpc() takes care of re-raising InsufficientCreditError for you. from odoo.addons.iap.tools import iap_tools def fetch_cur_rate(self): user_token = self.env['iap.account'].get('live_cur_ex_rate') service_endpoint = self.env['ir.config_parameter'].sudo().get_param('live_cur_ex_rate.endpoint', self._default_live_cur_ex_rate) for move in self: if move.company_currency_id == move.currency_id: raise UserError(_('Invoice currency and company currency is same, ' 'this document do not require exchange rates.')) params = { 'user_token': user_token.account_token, 'request_res_id': '%s,%s'%(move._name, move.id), 'from_cur': move.company_currency_id.name, 'to_cur': move.currency_id.name, } response = iap_tools.iap_jsonrpc(service_endpoint + '/curex/v1/convert', params=params) result = response.get('result', 0) if not result: raise UserError(_('Could not get the result please try again later. ' 'No credit was consumed for this request.')) move.write({ 'iap_curex_rate': result, 'iap_curex_rate_dt': fields.Datetime.now(), }) credit = self.env['iap.account'].get_credits('live_cur_ex_rate') credit_url = self.env['iap.account'].get_credits_url('live_cur_ex_rate') return {'type': 'ir.actions.act_window_close'}
- 20. Transaction API The Service Provider Side
- 21. Capture (/iap/1/capture) Authorize (/iap/1/authorize) Cancel /iap/1/authorize Verifies that the user’s account has at least asked credit available and creates a hold (pending transaction) on that amount. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Cancels the specified transaction, releasing the hold on the user’s credits.
- 22. IAP Service Helpers In Build Helper to implement IAP Service side using Odoo
- 23. iap.tools.iap_tools.iap_authorize iap.tools.iap_tools.iap_charge iap.tools.iap_tools.iap_capture A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Captures the amount credit on the given transaction. iap.tools.iap_tools.iap_cancel Cancels an authorized transaction.
- 24. iap.tools.iap_tools.iap_authorize iap.tools.iap_tools.iap_charge iap.tools.iap_tools.iap_capture A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Captures the amount credit on the given transaction. iap.tools.iap_tools.iap_cancel Cancels an authorized transaction.
- 25. iap.tools.iap_tools.iap_authorize iap.tools.iap_tools.iap_charge iap.tools.iap_tools.iap_capture A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Captures the amount credit on the given transaction. iap.tools.iap_tools.iap_cancel Cancels an authorized transaction.
- 26. iap.tools.iap_tools.iap_authorize iap.tools.iap_tools.iap_charge iap.tools.iap_tools.iap_capture A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Captures the amount credit on the given transaction. iap.tools.iap_tools.iap_cancel Cancels an authorized transaction.
- 27. iap.tools.iap_tools.iap_authorize iap.tools.iap_tools.iap_charge iap.tools.iap_tools.iap_capture A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Captures the amount credit on the given transaction. iap.tools.iap_tools.iap_cancel Cancels an authorized transaction.
- 28. Testing IAP
- 29. ➔ By default, iap_charge contacts the production IAP endpoint, ◆ https://iap.odoo.com ➔ While developing and testing your service you may want to point it towards the development IAP endpoint ◆ https://iap-sandbox.odoo.com ➔ To do so, set the iap.endpoint config parameter in your service Odoo: in debug/developer mode ● Setting ‣ Technical ‣ Parameters ‣ System Parameters ◆ just define an entry for the key iap.endpoint with value https://iap-sandbox.odoo.com, if none already exists.
- 30. ➔ By default, iap_charge contacts the production IAP endpoint, ◆ https://iap.odoo.com ➔ While developing and testing your service you may want to point it towards the development IAP endpoint ◆ https://iap-sandbox.odoo.com ➔ To do so, set the iap.endpoint config parameter in your service Odoo: in debug/developer mode ● Setting ‣ Technical ‣ Parameters ‣ System Parameters ◆ just define an entry for the key iap.endpoint with value https://iap-sandbox.odoo.com, if none already exists.
- 31. ➔ By default, iap_charge contacts the production IAP endpoint, ◆ https://iap.odoo.com ➔ While developing and testing your service you may want to point it towards the development IAP endpoint ◆ https://iap-sandbox.odoo.com ➔ To do so, set the iap.endpoint config parameter in your service Odoo: in debug/developer mode ● Setting ‣ Technical ‣ Parameters ‣ System Parameters ◆ just define an entry for the key iap.endpoint with value https://iap-sandbox.odoo.com, if none already exists.
- 32. DemoDemo Application code https://github.com/jam-odoo/odoo-iap-demo-app
- 33. Thank You
- 34. Chat Questions
Editor's Notes
- #2: Odoo logo centered w/ tagline
- #5: In-app purchases allow service providers to distribute their applications for free and charge users microtransaction fee when user initiate the services offered by the application. IAP credit are sold in packs and customer can buy credit pack as they need.
- #14: Place your own screenshot Select screenshot Click ‘Replace Image’ Select ‘Upload from computer’ from dropdown menu Choose photo Adjust accordingly, without distorting (stretching) photo
- #15: Place your own screenshot Select screenshot Click ‘Replace Image’ Select ‘Upload from computer’ from dropdown menu Choose photo Adjust accordingly, without distorting (stretching) photo
- #16: Place your own screenshot Select screenshot Click ‘Replace Image’ Select ‘Upload from computer’ from dropdown menu Choose photo Adjust accordingly, without distorting (stretching) photo
- #17: The credits went from integer to float value starting October 2018. Integer values are still supported for backward compatibilities. Every service provided through the IAP platform can be used by the clients with tokens or credits. The credits are an float unit and their monetary value depends on the service and is decided by the provider. Examples of credit and consumption: for a sms service : 1 credit = 1 sms for an ad service : 10 credit = 100 Char Ad or for a postage service : 1 credit = 1 post stamp. The value of the credits is fixed with the help of prepaid credit packs that the clients can buy on iap.odoo.com (see Packs).
- #19: The second step is to develop an Odoo App which clients can install in their Odoo instance and through which they can request the services you provide. First, we will create an odoo module depending on iap. IAP is a standard from V11 onwards and the dependency ensures a local account is properly set up and we will have access to some necessary views and useful helpers. Add client side business logic that will call service side API that provides the desired service. There are no specific requirement of protocol and services on service and client side.
- #20: To make implementation easy, IAP provides a iap_jsonrpc() helper to call a JSON-RPC2 endpoint on an IAP service side Odoo instance and transparently re-raise related Odoo exceptions. Each transaction called over API will require client account token. The token of the current client that is provided by the iap.account model’s account_token field. You can retrieve the account for your service by calling env['iap.account'].get("service_name") where "service_name" is the name of the service registered under IAP Account.
- #23: Authorize Verifies that the user’s account has at least asked credit available and creates a hold (pending transaction) on that amount. Any amount currently on hold by a pending transaction is considered unavailable to further authorize calls. Returns a `TransactionToken` identifying the pending transaction which can be used to capture (confirm) or cancel said transaction. Capture Confirms the specified transaction, transferring the reserved credits from the user’s account to the service provider’s. Capture calls are idempotent: performing capture calls on an already captured transaction has no further effect. Cancel Cancels the specified transaction, releasing the hold on the user’s credits. Cancel calls are idempotent: performing capture calls on an already cancelled transaction has no further effect.
- #29: A context manager for authorizing and automatically capturing or cancelling transactions for use in the backend/proxy. Works much like e.g. a cursor context manager: immediately authorizes a transaction with the specified parameters; executes the with body; if the body executes in full without error, captures the transaction; otherwise cancels it.
- #30: Will authorize asked credit.
- #31: Will capture the amount credit on the given transaction.
- #32: Will cancel an authorized transaction.
- #47: And, now, we have 580 employees.