{"id":295,"date":"2020-05-22T21:06:08","date_gmt":"2020-05-22T21:06:08","guid":{"rendered":"https:\/\/franciscotapia.com\/?p=295"},"modified":"2020-11-29T11:44:08","modified_gmt":"2020-11-29T11:44:08","slug":"php-connection-to-confluence","status":"publish","type":"post","link":"https:\/\/franciscotapia.com\/en\/php-connection-to-confluence\/","title":{"rendered":"How to connect your PHP web application with confluence"},"content":{"rendered":"

With a simple call by \"get\" using CURL<\/strong> php library, we can connect to the Confluence<\/strong> documentation manager and link this documentation to your website. Let's see how we can do it.<\/p>\n\n\n\n

The first thing to do is read the Confluence REST API Documentation<\/a><\/strong>. In it you will be able to see the structure that we need in the URLs, the parameters and the data that we can obtain from confluence such as the HTML content of a page, the tree menu, etc ...<\/p>\n\n\n\n

The Confluence REST API<\/strong> is protected by the same restrictions that are provided through the standard Confluence web interface. This means that if we don't log in, you are accessing Confluence anonymously. Also, if we are logged in and you don't have permission to see something in Confluence, you won't be able to see it using the Confluence REST API either.<\/p>\n\n\n\n

The confluence authentication mode is based is basic authentication <\/strong><\/a>. This method sends a username and password in the headers<\/strong> of the request to connect.<\/p>\n\n\n\n

Let's see an example. Imagine that your username is user_confluence<\/em> and your password !con_pass_957<\/em>:<\/p>\n\n\n\n

1- Create a string with the username and password: user_confluence<\/em>: !con_pass_957<\/em>, Now encode the string using base64.<\/p>\n\n\n\n

2- To encode the string in base64 we use the function base64_encode:<\/p>\n\n\n\n

\n
<?php
echo base64_encode<\/em>(\"user_confluence:!con_pass_957\");
?><\/pre>\n\n\n\n
\n
\n
\n
The result of this string will be this: dXNlcl9jb25mbHVlbmNlOiFjb25fcGFzc185NTc=<\/p>\n<\/div><\/div>\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n
3- Now we add this string to the request headers:<\/p>\n\n\n\n
curl -D- \\\n   -X POST \\\n   -H \"Authorization: Basic dXNlcl9jb25mbHVlbmNlOiFjb25fcGFzc185NTc\" \\\n   -H \"Content-Type: application\/json\" \\\n   \"https:\/\/confluenc.domain\/rest\/api\/content\/123?expand=body.view\"<\/pre>\n<\/div><\/div>\n\n\n\n
This request will return, in JSON format<\/strong>, the HTML content of the page with ID 123.<\/p>\n\n\n\n
We can do a connection test using the free program Advanced REST client<\/a><\/strong>:<\/p>\n\n\n\n
\"Advanced<\/a><\/figure><\/div>\n\n\n\n
Once we know how to connect to confluence, we are going to pass this curl command to PHP code. The following example shows how to get the HTML content of a page:<\/p>\n\n\n\n
$ch = curl_init<\/em>();\n\ncurl_setopt<\/em>($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt<\/em>($ch, CURLOPT_HEADER, false);\ncurl_setopt<\/em>($ch, CURLOPT_VERBOSE, false);\ncurl_setopt<\/em>($ch, CURLOPT_SSL_VERIFYPEER, false);\ncurl_setopt<\/em>($ch, CURLOPT_COOKIEFILE, '');\ncurl_setopt<\/em>($ch, CURLOPT_FOLLOWLOCATION, true);\ncurl_setopt<\/em>($ch, CURLOPT_ENCODING, '');\n\n$header = array();\n$header[] = \"Authorization: Basic \" . base64_encode<\/em>(\"user_confluence:!con_pass_957\")<\/em>;\n$header[] = \"Content-Type: application\/json\";\n\n$page_id = 123;\n\n$url <\/em>= \"https:\/\/confluence.domain.com\/rest\/api\/content\/\" . $page_id . \"?expand=body.view\";\n\ncurl_setopt<\/em>($ch, CURLOPT_HTTPHEADER, $header);\ncurl_setopt<\/em>($ch, CURLOPT_URL, $url<\/em>);\n\n$result = curl_exec<\/em>( $ch );\n\nprint_r(json_decode($result, true));<\/pre>\n\n\n\n
As you can see, in the example, we make a call to confluence using curl and the url https:\/\/confluence.domain.com\/rest\/api\/content\/123?expand=body.view<\/p>\n\n\n\n
The confluence REST API<\/strong> offers different URL structures and parameters to get the different content. For example:<\/p>\n\n\n\n