用語集一覧の照会

概要

用語集一覧を照会する APIです。

用語集一覧照会

API URL

GET https://papago.apigw.ntruss.com/glossary/v1/?currentPage={page}&pageSize={size}

リクエストヘッダ

API呼び出し時に「リクエストヘッダ」情報が必要です。
リクエストヘッダの詳細ガイドは、用語集の概要をご参照ください。

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v2:{API Gateway Signature}

リクエストパラメータ

リクエスト例

import hashlib
import hmac
import base64
import time
import requests


def make_signature(access_key, secret_key, timestamp, url, method):
    timestamp = str(timestamp)
    secret_key = bytes(secret_key, 'UTF-8')

    message = method + " " + url + "\n" + timestamp + "\n" + access_key
    message = bytes(message, 'UTF-8')
    signingKey = base64.b64encode(hmac.new(secret_key, message, digestmod=hashlib.sha256).digest())
    return signingKey.decode('UTF-8')


def get_user_glossary():
    baseurl = "https://papago.apigw.ntruss.com" #{OpenAPI endpoint}
    url = "/glossary/v1/?currentPage={}&pageSize={}"

    access_key = "DonNfVLUKOMNnmXXXXXX" #{Main / Sub Account Access Key}
    secret_key = "W5RyNUbIzOuUsEM8v8eqreMdSQZHMm9nfgXXXXXX" #{Main / Sub Account Secret Key}
    timestamp = int(time.time() * 1000)
    method = "GET"
    url = url.format(1, 10)  # {change {} in url to page number and page size.}

    signature = make_signature(access_key, secret_key, timestamp, url, method)

    url = baseurl + url
    headers = {
        "x-ncp-apigw-timestamp": str(timestamp),
        "x-ncp-iam-access-key": access_key,
        "x-ncp-apigw-signature-v2": str(signature)
    }

    response = requests.get(url=url, verify=True, headers=headers)

レスポンス例

json
    "data": [
        {
            "glossaryKey": "c26b6e45-437c-43ea-ae7f-22adb03f7eb0",
            "glossaryName": "Glossary1",
            "wordCount": 2,
            "description": "Glossary1用語集の説明です。",
            "createdDateTime": 1700024446000,
            "updatedDateTime": 1700025426000
        }
    ],
    currentPage": 1, "totalPage": 5, "currentGlossaryCount": 20, "totalGlossaryCount": 30
    }