yacorapi

Table of Contents

• Description
• What is a yacorapi?
• Configuration
• Usage
  • Switch to production
• Examples
• Project Status
• Additional Information
• Notice
• Reference

Description

Managing the maintenance of a Confluence instance by REST API

What is a yacorapi?

Y - et
a - nother
-
co - nfluence
r - est
api

Configuration

Please read the configuration.

Usage

The functions are separated in subfolders uner example

• Restapi → Base folder for all REST-API examples

• Projectdoc → Examples using the Projectdoc Toolbox

Starting a function is easy from the shell (commandline)

php -f ./example/<subfolder>/<function>.php

E.g.

php -f ./example/search/searchpage.php

The results are printed to the console or into a file in the target folder

./target/<subfolder>/<yyyymmdd-hhnnss>/<function>.<extension>

The output can be

• Text

• CSV

• JSON

Switch to production

By default the requests are sent to the URL of #confluence-url_for_testing#

• Edit the file:

  • Unix / Linux: ${HOME}/.yacorapi/myauth.php

  • Windows: %USERPROFILE%\.yacorapi\myauth.php

• Set CONST USE_PROD = false to CONST USE_PROD = true

Examples

Please read some examples.

Project Status

Please read the project status.

Additional Information

• Composer Commands - New commands for composer

Notice

• Examples are working with privat access token (PAT) only!

• Tested & Working with the Confluence Data Center Edition (DCE)

Reference

• Composer

(c) 2024 by Oliver Glowa