如何创建一个与Python融合的新页面

时间:2015-10-16 10:20:24

标签: python confluence confluence-rest-api

我正在尝试使用Python xmlrpclib创建一个新页面进入融合。我已经知道如何更新现有页面的内容,但是如何创建一个全新的页面呢?

我使用以下脚本来更新内容:

import xmlrpclib

CONFLUENCE_URL='https://wiki.*ownURL*/rpc/xmlrpc'

def update_confluence(user, pwd, pageid, newcontent):    
    client = xmlrpclib.Server(CONFLUENCE_URL,verbose=0)      
    authToken=client.confluence2.login(user,pwd)
    page = client.confluence2.getPage(authToken, pageid)
    page['content'] = newcontent
    cient.confluence2.storePage(authToken, page)
    client.confluence2.logout(authToken)

在更新内容时效果很好。但问题是,在创建新页面时我需要以某种方式解决pageID,而我不知道该怎么做。

有没有其他方法可以创建新页面?

3 个答案:

答案 0 :(得分:2)

您可以使用Confluence REST API创建页面: https://docs.atlassian.com/atlassian-confluence/REST/latest-server/

这是一个适用于Python3的示例。您需要知道父页面ID。

import requests
import json
import base64

# Set the confluence User and Password for authentication
user = 'USER'
password = 'PASSWORD'

# Set the title and content of the page to create
page_title = 'My New Page'
page_html = '<p>This page was created with Python!</p>'

# You need to know the parent page id and space key.
# You can use the /content API to search for these values.
# Parent Page example http://example.com/display/ABC/Cheese
# Search example: http://example.com/rest/api/content?title=Cheese
parent_page_id = 123456789
space_key = 'ABC'

# Request URL - API for creating a new page as a child of another page
url = 'http://example.com/rest/api/content/'

# Create the basic auth for use in the authentication header
auth = base64.b64encode(b'{}:{}'.format(user, password))

# Request Headers
headers = {
    'Authorization': 'Basic {}'.format(auth),
    'Content-Type': 'application/json',
}

# Request body
data = {
    'type': 'page',
    'title': page_title,
    'ancestors': [{'id':parent_page_id}],
    'space': {'key':space_key},
    'body': {
        'storage':{
            'value': page_html,
            'representation':'storage',
        }
    }
}

# We're ready to call the api
try:

    r = requests.post(url=url, data=json.dumps(data), headers=headers)

    # Consider any status other than 2xx an error
    if not r.status_code // 100 == 2:
        print("Error: Unexpected response {}".format(r))
    else:
        print('Page Created!')

except requests.exceptions.RequestException as e:

    # A serious problem happened, like an SSLError or InvalidURL
    print("Error: {}".format(e))

答案 1 :(得分:0)

我不懂Python,但可以通过REST调用来实现:

echo '{"type":"page","ancestors":[{"type":"page","id":'$CONFLUENCE_PARENT_PAGE'}],"title":"'$PAGE_NAME'","space":{"key":"'$CONFLUENCE_SPACE'"},"body":{"storage":{"value":"'$CONTENT'","representation":"storage"}}}' > body.json

curl --globoff --insecure --silent -u ${CONFLUENCE_USER}:${CONFLUENCE_PASSWORD} -X POST -H 'Content-Type: application/json' --data @body.json $CONFLUENCE_REST_API_URL

confluence rest api url看起来像这样: https://confluence.yourdomain.com/rest/api/content/

基本上,您的问题的答案是您需要在创建全新页面时将父页面作为祖先发送。

答案 2 :(得分:0)

“ J。Antunes”的答案是正确的,但是我花了很长时间才找到API,pageIds等。此答案将为您提供逐步指南,说明如何使用 API令牌实现此目标

第1步:在Confluence中生成API令牌。

在融合页面中,转到“设置”,然后单击密码。单击“创建和管理API令牌”并获取令牌。 {TOKEN}

enter image description here

第2步:在以下位置找到要创建子页面的父页面

转到get the parent page ID,找到 {父页面ID}

第3步:获取空格键

在融合时,转到“空间设置”,找到提到的Space Key。 {SPACE KEY}

enter image description here

步骤4:现在开始使用代码

import requests
import json
from requests.auth import HTTPBasicAuth

# set auth token and get the basic auth code
auth_token = "{TOKEN}"
basic_auth = HTTPBasicAuth('{email you use to log in}', auth_token)

# Set the title and content of the page to create
page_title = 'My New Page'
page_html = '<p>This page was created with Python!</p>'

parent_page_id = {Parent Page ID}
space_key = '{SPACE KEY}'

# get the confluence home page url for your organization {confluence_home_page}
url = '{confluence_home_page}/rest/api/content/'

# Request Headers
headers = {
    'Content-Type': 'application/json;charset=iso-8859-1',
}

# Request body
data = {
    'type': 'page',
    'title': page_title,
    'ancestors': [{'id':parent_page_id}],
    'space': {'key':space_key},
    'body': {
        'storage':{
            'value': page_html,
            'representation':'storage',
        }
    }
}

# We're ready to call the api
try:

    r = requests.post(url=url, data=json.dumps(data), headers=headers, auth=basic_auth)

    # Consider any status other than 2xx an error
    if not r.status_code // 100 == 2:
        print("Error: Unexpected response {}".format(r))
    else:
        print('Page Created!')

except requests.exceptions.RequestException as e:

    # A serious problem happened, like an SSLError or InvalidURL
    print("Error: {}".format(e))