Opentaps Wiki - User contributions [en]

CRM-2 Administrative API

2014-08-07T12:29:00Z

Krybalko: /* Twitter */

Administrative API is used to manage your domain.

The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>https://crm2.opentaps.com/admin/</tt>

To access the admin API, your user must have the '''DOMAIN_CONF''' permission.

For all requests the clientDomain and authToken parameters are required.

Here are the additional resources available:

=== Reset (Permanent) Token ===

Method: POST
URL extension: <tt>/admin/reset-token</tt>
Parameter:
* Current permanent auth token for your user
* Client domain

This API expires (deletes) the current permanent auth token, generates a new one, and returns it to you as the result. After this, you must use the new one to access the system. The API will validate that the token you've supplied is for a user of your domain.

=== Users ===

Add or remove users for a Contact

URL extension: <tt>/admin/user</tt>

Parameters:
* contactId : unique ID of your Contact
* userId: id of user. For Gmail, use full email (someone@gmail.com). For twitter, use username without the initial @ (someone)
* userIdType: type of your user id. Use GOOGLE_APPS for Gmail or TWITTER_LOGIN for Twitter.

Add a new User and Contact at the same time with

URL extension: <tt>/admin/user-contact</tt>

Parameters:
* firstName
* lastName
* companyName
* emailAddress
* userId
* userIdType: Same as above

=== User Permissions ===

Add or remove a security permission from a user

URL extension: <tt>/admin/user-permission</tt>

Parameters:
* userId: unique id of the user
* permission: Permission string

If the permission you are trying to add is not a valid permission, you will get an error message with a list of the valid permissions.

=== Email Notifications ===

Configure the email account to use when sending notification emails for your domain. You must also configure the same email as an email to poll (see below) separately so that the responses are also registered. Otherwise, response to your notification emails will be ignored.

URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-notifications</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>smtps</tt> and <tt>smtp.gmail.com</tt> for protocol and host.

For all requests the clientDomain and authToken parameters are required.

* The method POST and PUT is used to SET the email notification account settings.
* The method DELETE is used to REMOVE the email notification account settings.
* The method GET is used to GET the current email notification account settings.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Emails To Poll ===

Configures the emails to be polled for your domain.

URL extension: <tt>/admin/email-to-poll</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-to-poll</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>gimap</tt> and <tt>pop.googlemail.com</tt> for protocol and host.

* The method POST is used to ADD email to poll.
* The method PUT is used to UPDATE email to poll.
* The method DELETE is used to REMOVE email to poll.
* The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Valid Activity Types ===

Configures the valid activity types for your domain's application settings. Activity types are always capitalized and automatically capitalized when you add them.

URL: <tt>https://crm2.opentaps.com/admin/activity-type</tt>

* POST adds a single activityType
* GET returns a list of valid activity types
* DELETE removes a single activityType

=== Twitter ===

Configures the twitter users which opentaps CRM2 uses to interact with twitter. Normally this is done automatically when somebody logs into twitter.com once from the login page, but you can control it more explicitly using this API to add a user or remove one that you don't want to use.

URL: <tt>https://crm2.opentaps.com/admin/twitter</tt>

* POST adds a new user to use with twitter. Parameters are <tt>userName</tt>, <tt>userId</tt>, <tt>token</tt>, and <tt>tokenSecret</tt>
* GET returns a list of users to use with twitter
* DELETE removes a user. Parameter is <tt>userName</tt>

Set up CRM2

2013-12-17T12:34:27Z

Krybalko: /* Setting up the WordPress Contact Form */

__TOC__

=== First Steps ===

This shows you how to set up opentaps CRM2

The first step is to request an account with an API key by [http://www.opentaps.org/Contact contacting us].

Once you have received your permanent authorization token key by email, reset it

<pre>
$ curl -X POST 'https://crm2.opentaps.com/admin/reset-token' -d clientDomain= ${yourDomain} -d authToken=${authToken}
</pre>

'''Keep your new auth token secret!''' Someone with this token will be able to access everything in your account.

=== Setting Up with opentaps in the Cloud ===

If you are using an [http://www.opentaps.org/cloud opentaps in the Cloud] Amazon EC2 instance from an instance which says "crm2", then CRM2 is already pre-loaded for you. Simply edit the file <tt>hot-deploy/crm2/config/crm2.properties</tt> and populate your settings:

<pre>
crm2.activities.widget.baseOpentapsUrl = https://your-ec2-instance-ip.compute-1.amazonaws.com
crm2.activities.widget.authToken = your-auth-token-value
crm2.activities.widget.clientDomain = your-domain.com
</pre>

Then, restart opentaps

<pre>
$ /etc/init.d/opentaps restart
</pre>

You should see an activities widget similar to those from [[Tour of CRM2]] in your CRM system.

=== Setting up for opentaps 1.x ===

If you are using an older AMI which does not have "crm2" in its name, or if you are running opentaps on your own server, then you will have to get the code for crm2. You can check it out of our subversion repository into the opentaps/ directory (opentaps 1.5) or hot-deploy directory (earlier versions) like this:

<pre>
$ svn co svn://svn.opentaps.org/opentaps_crm2/opentaps_1.5/crm2 crm2
</pre>

Out of the box, this code works for opentaps 1.5. If you are using opentaps 1.4 or earlier versions, you will need to replace some of the lines which are for opentaps 1.5 with those for earlier versions. Edit the file <tt>src/com/opentaps/crm2/ContactExportService.java</tt> and search for "opentaps 1.5" and follow the instructions to comment out and uncomment the appropriate lines.

Next, compile the new module with

<pre>
$ ant
</pre>

Add the new module to either opentaps/component-load.xml or hot-deploy/component-load.xml file with

<pre>
<load-component component-location="crm2"/>
</pre>

If you have the [http://www.opentaps.org/services-support/professional-edition opentaps Professional Edition], just uncomment lines between
<pre>

</pre>
in the following files:
<pre>
opentaps/crmsfa/webapp/crmsfa/orders/viewOrder.ftl
opentaps/crmsfa/widget/crmsfa/screens/accounts/AccountsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/contacts/ContactsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/leads/LeadsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/orders/OrdersScreens.xml
opentaps/opentaps-common/webapp/common/WEB-INF/common-controller.xml
opentaps/purchasing/webapp/purchasing/order/viewOrder.ftl
opentaps/purchasing/widget/purchasing/screens/order/OrderScreens.xml
opentaps/purchasing/widget/purchasing/screens/supplier/SupplierScreens.xml
</pre>

If not, download the [http://sourceforge.net/projects/opentaps/files/opentaps%202/CRM2/opentaps-1.5-crm2.patch/download patch file for crm2] and apply it to your opentaps.

Finally, follow the instructions above to configure your <tt>crm2/config/crm2.properties</tt> file and restart opentaps.

=== Exporting Users to CRM2 ===

To export your users to CRM2, run the service <tt>exportContactsToCrm2</tt> with the following parameters:
* authToken
* clientDomain
* exportContactUrl: https://crm2.opentaps.com/crm2/contact-import
* exportUserUrl: https://crm2.opentaps.com/crm2/users

This services uses entity sync. Newly created or updated contacts will be added. If the party has a user_login which has _VIEW permission to CRMSFA or FINANCIALS (through any of his user_login_security_permission_group), his user_login_id will be imported as a user_id without password

This service can be set up to run regularly as a job, so new users are automatically added to CRM2.

=== Setting up the WordPress Contact Form ===

* Copy opentaps_crm2/wordpress/template-crm2-contact.php to your wordpress curent theme directory
* Modify template-crm2-contact.php to set up your authToken and clientDomain
* Create new wordpress Page with template-crm2-contact.php template

Set up CRM2

2013-12-17T12:33:20Z

Krybalko: /* Setting up the WordPress Contact Form */

__TOC__

=== First Steps ===

This shows you how to set up opentaps CRM2

The first step is to request an account with an API key by [http://www.opentaps.org/Contact contacting us].

Once you have received your permanent authorization token key by email, reset it

<pre>
$ curl -X POST 'https://crm2.opentaps.com/admin/reset-token' -d clientDomain= ${yourDomain} -d authToken=${authToken}
</pre>

'''Keep your new auth token secret!''' Someone with this token will be able to access everything in your account.

=== Setting Up with opentaps in the Cloud ===

If you are using an [http://www.opentaps.org/cloud opentaps in the Cloud] Amazon EC2 instance from an instance which says "crm2", then CRM2 is already pre-loaded for you. Simply edit the file <tt>hot-deploy/crm2/config/crm2.properties</tt> and populate your settings:

<pre>
crm2.activities.widget.baseOpentapsUrl = https://your-ec2-instance-ip.compute-1.amazonaws.com
crm2.activities.widget.authToken = your-auth-token-value
crm2.activities.widget.clientDomain = your-domain.com
</pre>

Then, restart opentaps

<pre>
$ /etc/init.d/opentaps restart
</pre>

You should see an activities widget similar to those from [[Tour of CRM2]] in your CRM system.

=== Setting up for opentaps 1.x ===

If you are using an older AMI which does not have "crm2" in its name, or if you are running opentaps on your own server, then you will have to get the code for crm2. You can check it out of our subversion repository into the opentaps/ directory (opentaps 1.5) or hot-deploy directory (earlier versions) like this:

<pre>
$ svn co svn://svn.opentaps.org/opentaps_crm2/opentaps_1.5/crm2 crm2
</pre>

Out of the box, this code works for opentaps 1.5. If you are using opentaps 1.4 or earlier versions, you will need to replace some of the lines which are for opentaps 1.5 with those for earlier versions. Edit the file <tt>src/com/opentaps/crm2/ContactExportService.java</tt> and search for "opentaps 1.5" and follow the instructions to comment out and uncomment the appropriate lines.

Next, compile the new module with

<pre>
$ ant
</pre>

Add the new module to either opentaps/component-load.xml or hot-deploy/component-load.xml file with

<pre>
<load-component component-location="crm2"/>
</pre>

If you have the [http://www.opentaps.org/services-support/professional-edition opentaps Professional Edition], just uncomment lines between
<pre>

</pre>
in the following files:
<pre>
opentaps/crmsfa/webapp/crmsfa/orders/viewOrder.ftl
opentaps/crmsfa/widget/crmsfa/screens/accounts/AccountsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/contacts/ContactsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/leads/LeadsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/orders/OrdersScreens.xml
opentaps/opentaps-common/webapp/common/WEB-INF/common-controller.xml
opentaps/purchasing/webapp/purchasing/order/viewOrder.ftl
opentaps/purchasing/widget/purchasing/screens/order/OrderScreens.xml
opentaps/purchasing/widget/purchasing/screens/supplier/SupplierScreens.xml
</pre>

If not, download the [http://sourceforge.net/projects/opentaps/files/opentaps%202/CRM2/opentaps-1.5-crm2.patch/download patch file for crm2] and apply it to your opentaps.

Finally, follow the instructions above to configure your <tt>crm2/config/crm2.properties</tt> file and restart opentaps.

=== Exporting Users to CRM2 ===

To export your users to CRM2, run the service <tt>exportContactsToCrm2</tt> with the following parameters:
* authToken
* clientDomain
* exportContactUrl: https://crm2.opentaps.com/crm2/contact-import
* exportUserUrl: https://crm2.opentaps.com/crm2/users

This services uses entity sync. Newly created or updated contacts will be added. If the party has a user_login which has _VIEW permission to CRMSFA or FINANCIALS (through any of his user_login_security_permission_group), his user_login_id will be imported as a user_id without password

This service can be set up to run regularly as a job, so new users are automatically added to CRM2.

=== Setting up the WordPress Contact Form ===
* Copy opentaps_crm2/wordpress/template-crm2-contact.php to your wordpress curent theme directory
* Modify template-crm2-contact.php to set up your authToken and clientDomain
* Create new wordpress Page with template-crm2-contact.php template

Set up CRM2

2013-08-22T12:56:14Z

Krybalko:

Set up CRM2

2013-08-22T12:55:41Z

Krybalko:

CRM-2 Administrative API

2013-04-03T11:11:37Z

Krybalko: /* Emails To Poll */

Administrative API is used to manage your domain.

The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>http://crm-2-url/admin/</tt>

To access the admin API, your user must have the '''DOMAIN_CONF''' permission.

Here are the additional resources available:

=== Emails To Poll ===

Configures the emails to be polled for your domain.

URL extension: <tt>email-to-poll</tt> (ie, <tt>http://crm-2-url/admin/email-to-poll</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>imaps</tt> and <tt>pop.google.com</tt> for protocol and host.

For all requests the clientDomain and authToken parameters are required.

* The method POST is used to ADD email to poll.
* The method PUT is used to UPDATE email to poll.
* The method DELETE is used to REMOVE email to poll.
* The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.

CRM-2 Administrative API

2013-04-03T11:09:54Z

Krybalko: /* Emails To Poll */

Administrative API is used to manage your domain.

The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>http://crm-2-url/admin/</tt>

To access the admin API, your user must have the '''DOMAIN_CONF''' permission.

Here are the additional resources available:

=== Emails To Poll ===

Configures the emails to be polled for your domain.

URL extension: <tt>email-to-poll</tt> (ie, <tt>http://crm-2-url/admin/email-to-poll</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>imaps</tt> and <tt>pop.google.com</tt> for protocol and host.

For all requests the clientDomain and authToken parameters are required.

The method POST is used to ADD email to poll.
The method PUT is used to UPDATE email to poll.
The method DELETE is used to REMOVE email to poll.
The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.