odoo-addon-helpdesk-ticket-api 16.0.1.0.0

Expose an API-Key authenticated API to get and create helpdesk tickets.

This module exposes an API-Key authenticated API to get and create helpdesk tickets

Table of contents

• Configuration

• Usage

  • Create tiquets

  • Search tiquets

• Known issues / Roadmap

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Maintainers

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

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.

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. 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:

  • Álvaro Mellado <[e-mail]>

  • José Robles <[e-mail]>

• Som Connexio SCCL:

  • Gerard Funosas <[e-mail]>

Maintainers

This module is maintained by the OCA.

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.