Invalid API Key ' + '!
') + else: + response = ("No API Key Provided " + "!
") + + return response + + def generate_response(self, method, model, rec_id): + """This function is used to generate the response based on the type + of request and the parameters given""" + option = request.env['connection.api'].search( + [('model_id', '=', model)], limit=1) + model_name = option.model_id.model + + if method != 'DELETE': + data = json.loads(request.httprequest.data) + else: + data = {} + fields = [] + if data: + for field in data['fields']: + fields.append(field) + if not fields and method != 'DELETE': + return ("No fields selected for the model" + "
") + if not option: + return ("No Record Created for the model" + "
") + try: + if method == 'GET': + fields = [] + for field in data['fields']: + fields.append(field) + if not option.is_get: + return ("Method Not Allowed" + "
") + else: + datas = [] + if rec_id != 0: + partner_records = request.env[ + str(model_name)].search_read( + domain=[('id', '=', rec_id)], + fields=fields + ) + data = json.dumps({ + 'records': partner_records + }) + datas.append(data) + return request.make_response(data=datas) + else: + partner_records = request.env[ + str(model_name)].search_read( + domain=[], + fields=fields + ) + data = json.dumps({ + 'records': partner_records + }) + datas.append(data) + return request.make_response(data=datas) + except: + return ("Invalid JSON Data" + "
") + if method == 'POST': + if not option.is_post: + return ("Method Not Allowed" + "
") + else: + try: + data = json.loads(request.httprequest.data) + datas = [] + new_resource = request.env[str(model_name)].create( + data['values']) + partner_records = request.env[ + str(model_name)].search_read( + domain=[('id', '=', new_resource.id)], + fields=fields + ) + new_data = json.dumps({'New resource': partner_records, }) + datas.append(new_data) + return request.make_response(data=datas) + except: + return ("Invalid JSON Data" + "
") + if method == 'PUT': + if not option.is_put: + return ("Method Not Allowed" + "
") + else: + if rec_id == 0: + return ("No ID Provided" + "
") + else: + resource = request.env[str(model_name)].browse( + int(rec_id)) + if not resource.exists(): + return ("Resource not found" + "
") + else: + try: + datas = [] + data = json.loads(request.httprequest.data) + resource.write(data['values']) + partner_records = request.env[ + str(model_name)].search_read( + domain=[('id', '=', resource.id)], + fields=fields + ) + new_data = json.dumps( + {'Updated resource': partner_records, + }) + datas.append(new_data) + return request.make_response(data=datas) + + except: + return ("Invalid JSON Data " + "!
") + if method == 'DELETE': + if not option.is_delete: + return ("Method Not Allowed" + "
") + else: + if rec_id == 0: + return ("No ID Provided" + "
") + else: + resource = request.env[str(model_name)].browse( + int(rec_id)) + if not resource.exists(): + return ("Resource not found" + "
") + else: + + records = request.env[ + str(model_name)].search_read( + domain=[('id', '=', resource.id)], + fields=['id', 'display_name'] + ) + remove = json.dumps( + {"Resource deleted": records, + }) + resource.unlink() + return request.make_response(data=remove) + + @http.route(['/send_request'], type='http', + auth='none', + methods=['GET', 'POST', 'PUT', 'DELETE'], csrf=False) + def fetch_data(self, **kw): + """This controller will be called when sending a request to the + specified url, and it will authenticate the api-key and then will + generate the result""" + + http_method = request.httprequest.method + api_key = request.httprequest.headers.get('api-key') + auth_api = self.auth_api_key(api_key) + model = kw.get('model') + username = request.httprequest.headers.get('login') + password = request.httprequest.headers.get('password') + request.session.authenticate(request.session.db, username, + password) + model_id = request.env['ir.model'].search( + [('model', '=', model)]) + if not model_id: + return ("Invalid model, check spelling or maybe " + "the related " + "module is not installed" + "
") + + if auth_api == True: + if not kw.get('Id'): + rec_id = 0 + else: + rec_id = int(kw.get('Id')) + result = self.generate_response(http_method, model_id.id, rec_id) + return result + else: + return auth_api + + @http.route(['/odoo_connect'], type="http", auth="none", csrf=False, + methods=['GET']) + def odoo_connect(self, **kw): + """This is the controller which initializes the api transaction by + generating the api-key for specific user and database""" + + username = request.httprequest.headers.get('login') + password = request.httprequest.headers.get('password') + db = request.httprequest.headers.get('db') + try: + request.session.update(http.get_default_session(), db=db) + auth = request.session.authenticate(request.session.db, username, + password) + user = request.env['res.users'].browse(auth) + api_key = request.env.user.generate_api(username) + datas = json.dumps({"Status": "auth successful", + "User": user.name, + "api-key": api_key}) + return request.make_response(data=datas) + except: + return ("wrong login credentials" + "
") diff --git a/rest_api_odoo/doc/RELEASE_NOTES.md b/rest_api_odoo/doc/RELEASE_NOTES.md new file mode 100644 index 000000000..1dc2f535d --- /dev/null +++ b/rest_api_odoo/doc/RELEASE_NOTES.md @@ -0,0 +1,5 @@ +## Module
+
+
+
+
+
+ 
+
+
+
+
+
+
+ Community
+
+
+ Enterprise
+
+
+
+
+
+
+
+ 
+
+
+
+ + Odoo rest API
+ +
+
+
+
+
+
+ 
+
+
+ + Explore This + Module
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ + Overview +
+
+
+
+
+
+
+ The odoo Rest API module allow us to connect to database with the help
+ of GET , POST , PUT and DELETE requests.
+
+
+
+
+ 
+
+
+ + Features +
+
+
+
+
+
+
+
+
+ 
+ Api key generation using database authentication.
+
+
+ Api key generation using database authentication.
+
+
+
+
+ Authentication using the generated api key.
+
+
+ Authentication using the generated api key.
+
+
+
+
+
+ Available in Odoo 16.0 Community and Enterprise.
+
+
+ Available in Odoo 16.0 Community and Enterprise.
+
+
+
+
+ Can create records for the models we want to access.
+
+
+ Can create records for the models we want to access.
+
+
+
+
+
+ Choose specific fields for data fetching.
+
+
+ Choose specific fields for data fetching.
+
+
+
+
+
+ Choose specific methods like GET, POST etc.
+
+
+ Choose specific methods like GET, POST etc.
+
+
+
+
+
+ Create and update records from database.
+
+
+ Create and update records from database.
+
+
+
+
+
+ Delete records.
+
+
+ Delete records.
+
+
+
+ 
+
+
+ + Screenshots +
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ 
+
+
+ + Installing and configuration +
++
-
+
- First of all, we have to add a new parameter in odoo conf. + file. + +
- server_wide_modules = web, base, rest_api_odoo
+ - This will allow us to send request to server without + selecting database first.
- Incase if you have to + uninstall the module , you have to remove this parameter. +
- Next we can install the module. +
+ - After installing the Rest api app we can see a new api key + field in users. + + - Next we have to generate the api-key for the current + user.
- You can import the postman collections provided in the app + folder for authentication and interacting with database in + various methods. + +
+
+ +
+ 
+
+ + Authentication +
++
-
+
- Next you have to select the database and login. +
- We have attached Postman collections through which + you can + authenticate rest api. + +
- First, extract the zip file. Then, you will obtain the JSON-format file, which you can directly import into POSTMAN. +
- The url format will be like this - http://cybrosys:8016/odoo_connect + Replace 'cybrosys:8016' with your localhost port number. + +
- You have to provide database name, username and password + through the headers while sending request. + +
- If the authentication is successful , an api key will be + generated for the current user. + +
- This key will be used when sending api requests to + database. + +
- The response will be like this - {"Status": "auth + successful", "User": "Mitchell Admin", "api-key": + "66c2ebab-d4dc-42f0-87d0-d1646e887569"}. +
+
+ 
+
+
+
+
+
+
+
+ + Create records in Rest api app +
++
-
+
- After rest api authentication, we can create records in the + rest api app. + +
- Here we can choose the model, and also we can + choose the http methods. + +
- The api response will be based on these records. +
+ +
+ +
+ +
+
+
+ + Get Records +
++
-
+
- You can send GET request to retrieve data from the + database. + +
- The postman collection has been provided with app files for + sending request from postman. + +
- You have to provide username, password and api key through + the header. + +
- Model can be passed as argument as the technical name , and + also if you want + specific record you can provide the id as well. + +
- The format for GET method will be like this - http://cybrosys:8016/send_request?model=res.partner&Id=10. + +
- We can specify the fields inside the JSON data, and it will + be like this - {"fields": ["name", "email"]}. +
- This is the format of api response - {"records": [{"id": + 10, "email": "deco.addict82@example.com", "name": "Deco + Addict"}]}. + + +
+
+ + Create Records +
++
-
+
- Using POST method , you can create new records in the + database. + +
- Just make sure you enabled POST method for the model record + in rest api app , otherwise you will get 'method not + allowed' message. + +
- For creating record you have to provide the JSON data along + with the model. + +
- You can make use of the postman collection that we have + added with app files. + +
- The format for sending POST request will be like this - http://cybrosys:8016/send_request?model=res.partner. + +
- This is the format for JSON data - { + "fields" :["name", "phone"] , + "values": {"name": "abc", + "phone":"55962441552" + } }. + +
- Make sure the data entered in correct format otherwise you + will get 'Invalid JSON data' message. +
- Response will be in this format - {"New resource": + [{"id": 51, "name": "abc", "phone": "55962441552"}]}. + +
+
+ + Update Records +
+-
+
- Updation of records in the database can be done with PUT + method. + +
- You have to provide the model and also the id or the record + that you want to update. + +
- You can use the Postman collection that we have provided and , you + will be always have to send request with your login + credentials. Otherwise, it will be showing access denied. + +
- The format for sending PUT request will be like this - http://cybrosys:8016/send_request?model=res.partner&Id=46. + +
- Here too you have to provide the JSON data through which the + updates will be done. + +
- The response format will be like this - {"Updated + resource": [{"id": 46, "email": "abc@example.com", "name": + "Toni"}]}. +
+
+ + Delete Records +
++
-
+
- Database records can be deleted by sending DELETE method + request. + +
- For the deletion we have to provide the Model and the record + id that we want to delete. + +
- Make sure you have permission to delete files for the + selected model in the rest api record. + +
- The delete request format will be like this - http://cybrosys:8016/send_request?model=res.partner&Id=46. + +
- The response after successful deletion will be - + {"Resource deleted": [{"id": 46, "email": "abc@example.com", + "name": "Toni"}]}. +
+
+
+ 
+
+
+ + Related + Products +
+
+
+
+
+
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
+
+
+ 
+
+
+ + Our Services +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ + Odoo + Customization
+
+
+
+
+ 
+
+
+ + Odoo + Implementation
+
+
+
+
+
+ 
+
+
+ + Odoo + Support
+
+
+
+
+ 
+
+
+ + Hire + Odoo + Developer
+
+
+
+
+ 
+
+
+ + Odoo + Integration
+
+
+
+
+
+ 
+
+
+ + Odoo + Migration
+
+
+
+
+ 
+
+
+ + Odoo + Consultancy
+
+
+
+
+ 
+
+
+ + Odoo + Implementation
+
+
+
+ 
+
+
+ + Odoo + Licensing Consultancy
+
+
+
+
+ 
+
+
+ + Our + Industries +
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ + Trading +
++ Easily procure + and + sell your products
+
+
+
+
+ 
+
+
+ + POS +
++ Easy + configuration + and convivial experience
+
+
+
+
+ 
+
+
+ + Education +
++ A platform for + educational management
+
+
+
+
+ 
+
+
+ + Manufacturing +
++ Plan, track and + schedule your operations
+
+
+
+
+ 
+
+
+ + E-commerce & Website +
++ Mobile + friendly, + awe-inspiring product pages
+
+
+
+
+ 
+
+
+ + Service Management +
++ Keep track of + services and invoice
+
+
+
+
+ 
+
+
+ + Restaurant +
++ Run your bar or + restaurant methodically
+
+
+
+ 
+
+
+ + Hotel Management +
++ An + all-inclusive + hotel management application
+
+
+
+ 
+
+
+ + Support +
+
+
+
\ No newline at end of file
diff --git a/rest_api_odoo/views/connection_api_views.xml b/rest_api_odoo/views/connection_api_views.xml
new file mode 100644
index 000000000..3e22d7538
--- /dev/null
+++ b/rest_api_odoo/views/connection_api_views.xml
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+ 
+
+
+ + Create! +
+