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

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.