================
CRM LEAD DMS API
================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:fa88a5911e9d75e4ccaee78931e61a91ccfe34e0de09254e0edd30ad0752f428
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
|badge1| |badge2|
CRM LEAD DMS API
**Table of contents**
.. contents::
:local:
Configuration
=============
To give access to the API to a structure, go to
- Settings > Technical (debug mode) > Auth API Key
- Click create and select a user, save.
- Communicate the API-KEY to those in need to use the API.
Usage
=====
Example of curl to check crm-lead required documents with these variables to fill:
- `API_KEY`: authorized key from the odoo server's API-KEY (see previows paragraph)
- `BASE_URL`: target ODOO server's URL
- `ENDPOINT`: '/api/crm-lead/documents_required'
- `CRM_LEAD_TOKEN`: token of the crm-lead to check
.. code:: bash
curl -sX GET -H "api-key: $APIKEY" "$BASE_URL/$ENDPOINT/$CRM_LEAD_TOKEN"
Response:
- 200: OK
.. code-block:: JSON
{
"crm_lead_id": <<crm-lead-id>>,
"crm_lead_token": <<crm-lead-token>>,
"document_category": <<document-category-code>>,
"document_id": <<dms-file-id>>,
"document_exit": false
}
Known issues / Roadmap
======================
There are no issues for the moment.
Bug Tracker
===========
Bugs are tracked on `GitLab Issues <https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* SomIT SCCL
* Som Connexio SCCL
Contributors
~~~~~~~~~~~~
* `SomIT SCCL <https://somit.coop>`_:
* Álvaro García <alvaro.garcia@somit.coop>
* José Robles <jose.robles@somit.coop>
* `Som Connexio SCCL <https://somconnexio.coop>`_:
* Gerard Funosas <gerard.funosas@somconnexio.coop>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/somitcoop/erp-research/odoo-helpdesk",
"name": "odoo12-addon-crm-lead-dms-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": null,
"author": "Som It Cooperatiu SCCL, Som Connexi\u00f3 SCCL, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "https://files.pythonhosted.org/packages/ff/e4/7354344f85ff4b25ee784f98e8d533a6331f820426e12b907b6ed006b3b5/odoo12-addon-crm_lead_dms_api-12.0.0.1.0.tar.gz",
"platform": null,
"description": "================\nCRM LEAD DMS API\n================\n\n..\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:fa88a5911e9d75e4ccaee78931e61a91ccfe34e0de09254e0edd30ad0752f428\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n\n|badge1| |badge2|\n\nCRM LEAD DMS API\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nTo give access to the API to a structure, go to\n\n- Settings > Technical (debug mode) > Auth API Key\n- Click create and select a user, save.\n- Communicate the API-KEY to those in need to use the API.\n\n\nUsage\n=====\n\nExample of curl to check crm-lead required documents with these variables to fill:\n- `API_KEY`: authorized key from the odoo server's API-KEY (see previows paragraph)\n- `BASE_URL`: target ODOO server's URL\n- `ENDPOINT`: '/api/crm-lead/documents_required'\n- `CRM_LEAD_TOKEN`: token of the crm-lead to check\n\n\n.. code:: bash\n\n curl -sX GET -H \"api-key: $APIKEY\" \"$BASE_URL/$ENDPOINT/$CRM_LEAD_TOKEN\"\n\n\nResponse:\n- 200: OK\n\n .. code-block:: JSON\n \n {\n \"crm_lead_id\": <<crm-lead-id>>,\n \"crm_lead_token\": <<crm-lead-token>>,\n \"document_category\": <<document-category-code>>,\n \"document_id\": <<dms-file-id>>,\n \"document_exit\": false\n }\n\n\nKnown issues / Roadmap\n======================\n\nThere are no issues for the moment.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitLab Issues <https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed feedback.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* SomIT SCCL\n* Som Connexio SCCL\n\n\nContributors\n~~~~~~~~~~~~\n\n* `SomIT SCCL <https://somit.coop>`_:\n\n * \u00c1lvaro Garc\u00eda <alvaro.garcia@somit.coop>\n * Jos\u00e9 Robles <jose.robles@somit.coop>\n\n\n* `Som Connexio SCCL <https://somconnexio.coop>`_:\n\n * Gerard Funosas <gerard.funosas@somconnexio.coop>\n\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "API to check if a CRM Lead has all the required documents",
"version": "12.0.0.1.0",
"project_urls": {
"Homepage": "https://gitlab.com/somitcoop/erp-research/odoo-helpdesk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "182008efc7d94613703110a666d82f04a646e49b2d0779d7075598765c086629",
"md5": "64a86e6d16c777edecbf79ee67ff22f6",
"sha256": "8dc9b808ec2b5d6c25abed891acf4bfe7a5ef886847bb5fb840536a7cb3578fd"
},
"downloads": -1,
"filename": "odoo12_addon_crm_lead_dms_api-12.0.0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64a86e6d16c777edecbf79ee67ff22f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 20336,
"upload_time": "2024-07-09T10:51:56",
"upload_time_iso_8601": "2024-07-09T10:51:56.744574Z",
"url": "https://files.pythonhosted.org/packages/18/20/08efc7d94613703110a666d82f04a646e49b2d0779d7075598765c086629/odoo12_addon_crm_lead_dms_api-12.0.0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ffe47354344f85ff4b25ee784f98e8d533a6331f820426e12b907b6ed006b3b5",
"md5": "d59d0aa2f884ce5264fccfa977131ebb",
"sha256": "5bf76247e3f3194fd363b432c0b08f58045b31ece4cba7e70c6c0ea1c15b8b05"
},
"downloads": -1,
"filename": "odoo12-addon-crm_lead_dms_api-12.0.0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d59d0aa2f884ce5264fccfa977131ebb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 16639,
"upload_time": "2024-07-09T10:51:58",
"upload_time_iso_8601": "2024-07-09T10:51:58.645082Z",
"url": "https://files.pythonhosted.org/packages/ff/e4/7354344f85ff4b25ee784f98e8d533a6331f820426e12b907b6ed006b3b5/odoo12-addon-crm_lead_dms_api-12.0.0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 10:51:58",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "somitcoop",
"gitlab_project": "erp-research",
"lcname": "odoo12-addon-crm-lead-dms-api"
}
JSON