manifest / integrations / civicrm-wp-rest
CiviCRM WP REST API
A WordPress plugin that exposes CiviCRM's extern scripts as WordPress REST endpoints.
★ 4stars
Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/mecachisenros/civicrm-wp-rest/archive/refs/heads/master.zipNo built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
CiviCRM WP REST API Wrapper
This is a WordPress plugin that aims to expose CiviCRM's extern scripts as WordPress REST endpoints.
This plugin requires:
- PHP 7.0+
- WordPress 4.7+
- CiviCRM to be installed and activated.
Endpoints
1. civicrm/v3/rest - a wrapper around civicrmapi3()
Parameters:
- key - required, the site key
- apikey - required, the contact api key
- entity - required, the API entity
- action - required, the API action
- json - optional, json formatted string with the API parameters/argumets, or 1 as in json=1
It mimics CiviCRM's REST interface, by default all calls to civicrm/v3/rest return XML formatted results, to get json formatted result pass json=1 or a json formatted string with the API parameters, like in the example 2 below.
Examples:
1. https://example.com/wp-json/civicrm/v3/rest?entity=Contact&action=get&key=&apikey=&group=Administrators
2. https://example.com/wp-json/civicrm/v3/rest?entity=Contact&action=get&key=&apikey=&json={"group": "Administrators"}
2. civicrm/v3/url - a substition for civicrm/extern/url.php mailing tracking
3. civicrm/v3/open - a substition for