#####################
Helpdesk Ticket 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
:alt: Beta
:target: https://odoo-community.org/page/development-status
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:alt: License: AGPL-3
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|badge1| |badge2|
This module exposes an API-Key authenticated API to get and create
helpdesk tickets
**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
*******
Create tiquets
==============
Example of curl to create a ticket with two variables to fill: -
`API_KEY`: authorized key from the odoo server's API-KEY (see previows
paragraph) - `ODOO_URL`: target ODOO server's URL - `CONTENT`: base64
encoded image to attach to the ticket
Tickets can be created by just one of the following parameters: -
`partner_ref` - `partner_email` - `partner_vat` - `contract_code`
- "attachments" is an array of objects, optional, each one with the
following fields: - `filename`: name of the file - `content`: base64
encoded file - `mimetype`: mimetype of the file
.. code:: bash
CONTENT=$(base64 image.jpg)
curl -X POST \
-H "accept: application/json" \
-H "api-key: $APIKEY" \
-H "Content-Type: application/json" \
-d "$(jq -n --arg content "$CONTENT" \
'{
summary: "New Ticket",
description: "this is an API created ticket",
partner_ref: "2828",
team: "HTTe_loc",
category: "HTCa_soft",
channel: "HTCh_web",
priority: "0",
tags: "HTTa_hard,HTTa_tec",
attachments: [
{
filename: "image_name",
content: $content,
mimetype: "image/jpg"
}
]
}')" \
"$ODOO_URL/api/ticket"
Search tiquets
==============
Tickets can be search by, either:
- `partner_ref`, returning those tickets linked to the given partner
- `contract_code`, returning those tickets related to the given
contract.
Also, and in any of these cases, we can filter by `stage`, using the
stage code to exclude from our result all tickets in a different stage.
.. code:: bash
curl -X GET \
-H "accept: application/json" \
-H "api-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"partner_ref": "10112",
"stage": "stage_code",
}' \
"$ODOO_URL/api/ticket/getlist"
************************
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 Mellado <alvaro.mellado@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-helpdesk-ticket-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/6d/40/3c8ae245e467211ea07af43b8b65f6a5d2632addd25b712f61dd36199777/odoo12-addon-helpdesk_ticket_api-12.0.0.2.0.tar.gz",
"platform": null,
"description": "#####################\n Helpdesk Ticket 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 :alt: Beta\n :target: https://odoo-community.org/page/development-status\n\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :alt: License: AGPL-3\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n\n|badge1| |badge2|\n\nThis module exposes an API-Key authenticated API to get and create\nhelpdesk tickets\n\n**Table of contents**\n\n.. contents::\n :local:\n\n***************\n Configuration\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*******\n Usage\n*******\n\nCreate tiquets\n==============\n\nExample of curl to create a ticket with two variables to fill: -\n`API_KEY`: authorized key from the odoo server's API-KEY (see previows\nparagraph) - `ODOO_URL`: target ODOO server's URL - `CONTENT`: base64\nencoded image to attach to the ticket\n\nTickets can be created by just one of the following parameters: -\n`partner_ref` - `partner_email` - `partner_vat` - `contract_code`\n\n- \"attachments\" is an array of objects, optional, each one with the\n following fields: - `filename`: name of the file - `content`: base64\n encoded file - `mimetype`: mimetype of the file\n\n.. code:: bash\n\n CONTENT=$(base64 image.jpg)\n\n curl -X POST \\\n -H \"accept: application/json\" \\\n -H \"api-key: $APIKEY\" \\\n -H \"Content-Type: application/json\" \\\n -d \"$(jq -n --arg content \"$CONTENT\" \\\n '{\n summary: \"New Ticket\",\n description: \"this is an API created ticket\",\n partner_ref: \"2828\",\n team: \"HTTe_loc\",\n category: \"HTCa_soft\",\n channel: \"HTCh_web\",\n priority: \"0\",\n tags: \"HTTa_hard,HTTa_tec\",\n attachments: [\n {\n filename: \"image_name\",\n content: $content,\n mimetype: \"image/jpg\"\n }\n ]\n }')\" \\\n \"$ODOO_URL/api/ticket\"\n\nSearch tiquets\n==============\n\nTickets can be search by, either:\n - `partner_ref`, returning those tickets linked to the given partner\n - `contract_code`, returning those tickets related to the given\n contract.\n\nAlso, and in any of these cases, we can filter by `stage`, using the\nstage code to exclude from our result all tickets in a different stage.\n\n.. code:: bash\n\n curl -X GET \\\n -H \"accept: application/json\" \\\n -H \"api-key: $API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"partner_ref\": \"10112\",\n \"stage\": \"stage_code\",\n }' \\\n \"$ODOO_URL/api/ticket/getlist\"\n\n************************\n Known issues / Roadmap\n************************\n\nThere are no issues for the moment.\n\n*************\n Bug Tracker\n*************\n\nBugs are tracked on `GitLab Issues\n<https://gitlab.com/somitcoop/erp-research/odoo-helpdesk/-/issues>`_. In\ncase of trouble, please check there if your issue has already been\nreported. If you spotted it first, help us smashing it by providing a\ndetailed and welcomed feedback.\n\nDo not contact contributors directly about support or help with\ntechnical issues.\n\n*********\n Credits\n*********\n\nAuthors\n=======\n\n- SomIT SCCL\n- Som Connexio SCCL\n\nContributors\n============\n\n- `SomIT SCCL <https://somit.coop>`_:\n\n - \u00c1lvaro Mellado <alvaro.mellado@somit.coop>\n - Jos\u00e9 Robles <jose.robles@somit.coop>\n\n- `Som Connexio SCCL <https://somconnexio.coop>`_:\n\n - Gerard Funosas <gerard.funosas@somconnexio.coop>\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\nwhose mission is to support the collaborative development of Odoo\nfeatures and promote its widespread use.\n\nYou are welcome to contribute. To learn how please visit\nhttps://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Expose an API-Key authenticated API to get and create helpdesk tickets.",
"version": "12.0.0.2.0",
"project_urls": {
"Homepage": "https://gitlab.com/somitcoop/erp-research/odoo-helpdesk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac0a02c6895b4265d483ae97aefd5013624ab9e5a0245659bbe47b032d114be9",
"md5": "82a818ca887412b3cd74376b872d2121",
"sha256": "bf7acf3324fb90a329ed5f6207823a4f2454d3bc1c81397c813e75fc54f561eb"
},
"downloads": -1,
"filename": "odoo12_addon_helpdesk_ticket_api-12.0.0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "82a818ca887412b3cd74376b872d2121",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 38039,
"upload_time": "2024-09-25T10:29:35",
"upload_time_iso_8601": "2024-09-25T10:29:35.697055Z",
"url": "https://files.pythonhosted.org/packages/ac/0a/02c6895b4265d483ae97aefd5013624ab9e5a0245659bbe47b032d114be9/odoo12_addon_helpdesk_ticket_api-12.0.0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d403c8ae245e467211ea07af43b8b65f6a5d2632addd25b712f61dd36199777",
"md5": "2e689f8e31c183c3a7047acf804d31c6",
"sha256": "8679af3161f42f2075122d3203055b56033cc528c1d614df3fea1eabae20836b"
},
"downloads": -1,
"filename": "odoo12-addon-helpdesk_ticket_api-12.0.0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2e689f8e31c183c3a7047acf804d31c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 31676,
"upload_time": "2024-09-25T10:29:37",
"upload_time_iso_8601": "2024-09-25T10:29:37.538246Z",
"url": "https://files.pythonhosted.org/packages/6d/40/3c8ae245e467211ea07af43b8b65f6a5d2632addd25b712f61dd36199777/odoo12-addon-helpdesk_ticket_api-12.0.0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 10:29:37",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "somitcoop",
"gitlab_project": "erp-research",
"lcname": "odoo12-addon-helpdesk-ticket-api"
}
JSON