Search 1.9 billion lines of Odoo code on GitHub

ecommerce_webservice

Author: Camptocamp, Odoo Community Association (OCA)
License: AGPL-3
Branch: 7.0
Repository: jt-xx/e-commerce
Dependencies: account, delivery, sale, sale_payment_method, and stock
Languages: INI (14, 1.1%), Python (885, 67.7%), XML (252, 19.3%), and make (156, 11.9%)
Other repositories: damdam-s/e-commerce, and guewen/e-commerce

<h1 class="title">Setup</h1> <p>Short guide for installation and configuration of the module.</p> <a name="configuration-of-users-and-access-rights"></a> <h2>Configuration of users and access rights</h2> <p>The web-service uses 2 users.</p> <ul class="simple"> <li>One public user that will be used for XML-RPC</li> <li>One internal user that will be used for all the accesses to the models internally</li> </ul> <a name="public-user"></a> <h3>Public user</h3> <ul class="simple"> <li>This user must have a strong password. It will be used for the web-service connections.</li> <li>It should have the group <code>Ecommerce API</code>, no more rights required, because the operations on the models will be done with the internal user.</li> </ul> <a name="internal-user"></a> <h3>Internal user</h3> <ul class="simple"> <li>This user should not have a password. Nobody should be able to login with it. It will be used internally by the Web-Service.</li> <li>It is automatically created by the module with the name <code>Ecommerce Default Internal User</code></li> <li>It should have the group <code>Own Ecommerce API Shop internal</code>. This group inherits all the <code>Sales Manager</code> accesses which should cover all the permissions needed for the Web-Service. If any access is missing, they should be granted to this user.</li> </ul> <a name="configuration-of-the-ecommerce-web-service"></a> <h2>Configuration of the Ecommerce web-service</h2> <ol class="arabic simple"> <li>Go in <code>Ecommerce API</code>.</li> <li>Create a new <code>Shop</code>. It proposes an identifier for the shop that will need to be communicated to the clients to allow them to access to this shop.</li> <li>On the shop, configure the public and internal users configured in the previous chapter.</li> <li>The selected <code>Sale Shop</code> will be the one in which the sales orders are created.</li> <li>You can choose to enable or disable logs.</li> </ol> <p>Based on this configuration, the XML-RPC client should use the following parameters:</p> <ul class="simple"> <li>login: the public login and password created previously</li> <li>shop identifier: the shop identifier of the new shop</li> </ul> <p>If a web-service is needed for another sales shop, a new Ecommerce shop must be created.</p>