odoo12-addon-dms-file-api 12.0.0.1.0

Expose an API-Key authenticated API to get and create dms files.

This module exposes an API-Key authenticated API to create dms files as attachments in partners and crm leads, focusing on the directory structure given by the inherited module “dms_res_model_root_directory”.

Table of contents

• Configuration

• Usage

• 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 files

Example of curl to create a dms file 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

Tickets can be created with either one of the following parameters, but not both: - partner_id - crm_lead_id

• “files” is an array of documents, each one with the following fields: - filename: name of the file - content: base64 encoded file

CONTENT=$(base64 test_pdf.pdf)

curl -X POST \
  -H "accept: application/json" \
  -H "api-key: $APIKEY" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --arg content "$CONTENT" \
        '{
            crm_lead_id: "New Ticket",
            category: "this is an API created ticket",
            attachments: [
              {
                filename: "test_pdf.pdf",
                content: $content,
              }
            ]
          }')" \
  "$ODOO_URL/api/documentation"

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 García <[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.