Skip to main content

API to check if a CRM Lead has all the required documents

Project description

Beta License: AGPL-3

CRM LEAD DMS API

Table of contents

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

curl -sX GET -H  "api-key: $APIKEY" "$BASE_URL/$ENDPOINT/$CRM_LEAD_TOKEN"

Response: - 200: OK

{
    "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. 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

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odoo-addon-crm_lead_dms_api-16.0.1.0.0.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

odoo_addon_crm_lead_dms_api-16.0.1.0.0-py2.py3-none-any.whl (20.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file odoo-addon-crm_lead_dms_api-16.0.1.0.0.tar.gz.

File metadata

File hashes

Hashes for odoo-addon-crm_lead_dms_api-16.0.1.0.0.tar.gz
Algorithm Hash digest
SHA256 9408776e8ec34c4ddd6454c0069b8e7b94ce34c7136da3652d7c71f004c3ce5b
MD5 0fb50e84eb864173bc25bf82e4c16b5a
BLAKE2b-256 0625564cbae299d2dd7506728432c0301361e2c70b2723d88b438608389ad978

See more details on using hashes here.

File details

Details for the file odoo_addon_crm_lead_dms_api-16.0.1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_crm_lead_dms_api-16.0.1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 312adef7798c4e3517ad8a5279178b7e5f5fb3f6df7d56e23a8de80f7ba8de44
MD5 2a121b9d1140579ffa0a16b871b27315
BLAKE2b-256 d0be375fa8356289e59e7ec4288e00471ab96325a26cf7e3a13748430c343822

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page