com.dotcms.dotzapier-plugin

README

How to build this example

To install all you need to do is build the JAR. to do this run ./gradlew jar

This will build two jars in the build/libs directory: a bundle fragment (in order to expose needed 3rd party libraries from dotCMS) and the plugin jar

• To install this bundle:

  Copy the bundle jar files inside the Felix OSGI container (dotCMS/felix/load).

  OR

  Upload the bundle jars files using the dotCMS UI (CMS Admin->Dynamic Plugins->Upload Plugin).

• To uninstall this bundle:

  Remove the bundle jars files from the Felix OSGI container (dotCMS/felix/load).

  OR

  Undeploy the bundle jars using the dotCMS UI (CMS Admin->Dynamic Plugins->Undeploy).

---

How to test

Once installed, you can access this resource by (this assumes you are on localhost)

http://localhost:8080/api/v1/dotzapier/health

To verify if authenticated users can access the resource, send the GET request to below mentioned url (this assumes you are on localhost)

http://localhost:8080/api/v1/dotzapier/auth-health

Authentication

This API supports the same REST auth infrastructure as other rest apis in dotcms. There are 4 ways to authenticate.

• user/xxx/password/yyy in the URI
• basic http/https authentication (base64 encoded)
• DOTAUTH header similar to basic auth and base64 encoded, e.g. setHeader("DOTAUTH", base64.encode("[email protected]:admin"))
• Session based (form based login) for frontend or backend logged in user