BacklogのURLパラメータ(/:xxx)指定方法を教えて下さい

requestsパッケージを使ってBacklog APIの中のプロジェクト情報の取得
をコールしたいのですが、
"/:projectIdOrKey"の部分をどのように指定すればよいか分かりません。
クエリパラメータのように下記で指定してみたものの、"projectIdOrKey"の値が正しく指定できていないためかエラーとなります。
(projectkeyの値は確実に存在するkeyを指定しています。)
前述のリファレンスによると"URLパラメータ"であり、指定方法が異なるのだと考えております。
お手数ですが助言をいただけないでしょうか。

import requests

url = "https://hogehoge.backlog.com/api/v2/"
projectkey = "hoge"
apikey = "xxx"
def getProjectKey():
    payload = {
        "apiKey": apikey,
        "projectIdOrKey": projectkey
    }
    url_projects = "{0}{1}".format(url, "projects/:projectIdOrKey")
    r = requests.get(url_projects, payload)
    print(r.text)

{"errors":[{"message":"No such project. (key::projectIdOrKey)","code":6,"moreInfo":""}]}

行動規範の内容に同意します

回答1件

ベストアンサー

APIドキュメントにある :projectIdOrKey はその文字列を使うのではなく、「その部分に要求する項目を入れる変数」の意味を持っています。（そのため、URLパラメーターとして可変であることを示しています）

そのため、リクエストのペイロードして渡すのではなく、URLに直接指定する必要があります。

python:該当箇所のみ記載
1def getProjectKey():
2    # 略
3    # URLの一部としてprojectKeyを用いる
4    url_projects = "{0}{1}{2}".format(url, "projects/", projectKey)
5    # 略