{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# \u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7 API [\u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7](https://shop-pro.jp) API\u3067\u306f\u3001\u53d7\u6ce8\u306e\u691c\u7d22\u3084\u5546\u54c1\u60c5\u5831\u306e\u66f4\u65b0\u3092\u884c\u3046\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002 ## \u5229\u7528\u624b\u9806 \u306f\u3058\u3081\u306b\u3001\u30ab\u30e9\u30fc\u30df\u30fc\u30c7\u30d9\u30ed\u30c3\u30d1\u30fc\u30a2\u30ab\u30a6\u30f3\u30c8\u3092\u7528\u610f\u3057\u307e\u3059\u3002[\u30c7\u30d9\u30ed\u30c3\u30d1\u30fc\u767b\u9332\u30da\u30fc\u30b8](https://api.shop-pro.jp/developers/sign_up)\u304b\u3089\u767b\u9332\u3057\u3066\u304f\u3060\u3055\u3044\u3002 \u6b21\u306b\u3001[\u767b\u9332\u30da\u30fc\u30b8](https://api.shop-pro.jp/oauth/applications/new)\u304b\u3089\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u767b\u9332\u3092\u884c\u3063\u3066\u304f\u3060\u3055\u3044\u3002 \u30b9\u30de\u30fc\u30c8\u30d5\u30a9\u30f3\u306eWebView\u3092\u5229\u7528\u3059\u308b\u5834\u5408\u306f\u3001\u30ea\u30c0\u30a4\u30ec\u30af\u30c8URL\u306b`urn:ietf:wg:oauth:2.0:oob`\u3092\u5165\u529b\u3057\u3066\u304f\u3060\u3055\u3044\u3002 \u305d\u306e\u5f8c\u3001\u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7\u30a2\u30ab\u30a6\u30f3\u30c8\u306e\u8a8d\u8a3c\u30da\u30fc\u30b8\u3092\u958b\u304d\u307e\u3059\u3002\u8a8d\u8a3c\u30da\u30fc\u30b8\u306eURL\u306f\u3001`https://api.shop-pro.jp/oauth/authorize`\u306b\u5fc5\u8981\u306a\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u3064\u3051\u305f\u3082\u306e\u3067\u3059\u3002 |\u30d1\u30e9\u30e1\u30fc\u30bf\u540d|\u5024| |---|---| |`client_id`|\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u8a73\u7d30\u753b\u9762\u3067\u78ba\u8a8d\u3067\u304d\u308b\u30af\u30e9\u30a4\u30a2\u30f3\u30c8ID| |`response_type`|\\"code\\"\u3068\u3044\u3046\u6587\u5b57\u5217| |`scope`| \u5225\u8868\u53c2\u7167| |`redirect_url`|\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u767b\u9332\u6642\u306b\u5165\u529b\u3057\u305f\u30ea\u30c0\u30a4\u30ec\u30af\u30c8URL| `scope`\u306f\u3001\u4ee5\u4e0b\u306e\u3046\u3061\u3001\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u304c\u5229\u7528\u3057\u305f\u3044\u6a5f\u80fd\u3092\u30b9\u30da\u30fc\u30b9\u533a\u5207\u308a\u3067\u6307\u5b9a\u3057\u3066\u304f\u3060\u3055\u3044\u3002 |\u30b9\u30b3\u30fc\u30d7|\u6a5f\u80fd| |---|---| |`read_products`|\u5546\u54c1\u30c7\u30fc\u30bf\u306e\u53c2\u7167| |`write_products`|\u5728\u5eab\u30c7\u30fc\u30bf\u306e\u66f4\u65b0| |`read_sales`|\u53d7\u6ce8\u30fb\u9867\u5ba2\u30c7\u30fc\u30bf\u306e\u53c2\u7167| |`write_sales`|\u53d7\u6ce8\u30c7\u30fc\u30bf\u306e\u66f4\u65b0| \u4ee5\u4e0b\u306e\u3088\u3046\u306aURL\u3068\u306a\u308a\u307e\u3059\u3002 ``` https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=read_products%20write_products ``` \u521d\u3081\u3066\u3053\u306e\u30da\u30fc\u30b8\u3092\u8a2a\u308c\u308b\u5834\u5408\u306f\u3001\u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7\u30a2\u30ab\u30a6\u30f3\u30c8\u306eID\u3068\u30d1\u30b9\u30ef\u30fc\u30c9\u306e\u5165\u529b\u3092\u6c42\u3081\u3089\u308c\u307e\u3059\u3002 \u627f\u8a8d\u30dc\u30bf\u30f3\u3092\u62bc\u3059\u3068\u3001\u3053\u306e\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u304c\u30b7\u30e7\u30c3\u30d7\u306e\u30c7\u30fc\u30bf\u306b\u30a2\u30af\u30bb\u30b9\u3059\u308b\u3053\u3068\u304c\u8a31\u53ef\u3055\u308c\u3001\u30ea\u30c0\u30a4\u30ec\u30af\u30c8URL\u3078\u30ea\u30c0\u30a4\u30ec\u30af\u30c8\u3055\u308c\u307e\u3059\u3002 \u627f\u8a8d\u3055\u308c\u305f\u5834\u5408\u306f\u3001`code`\u3068\u3044\u3046\u30af\u30a8\u30ea\u30d1\u30e9\u30e1\u30fc\u30bf\u306b\u8a8d\u53ef\u30b3\u30fc\u30c9\u304c\u4ed8\u4e0e\u3055\u308c\u307e\u3059\u3002\u627f\u8a8d\u304c\u30ad\u30e3\u30f3\u30bb\u30eb\u3055\u308c\u305f\u3001\u307e\u305f\u306f\u30a8\u30e9\u30fc\u304c\u8d77\u304d\u305f\u5834\u5408\u306f\u3001 `error`\u30d1\u30e9\u30e1\u30fc\u30bf\u306b\u30a8\u30e9\u30fc\u306e\u5185\u5bb9\u3092\u8868\u3059\u6587\u5b57\u5217\u304c\u4e0e\u3048\u3089\u308c\u307e\u3059\u3002 \u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u767b\u9332\u6642\u306e\u30ea\u30c0\u30a4\u30ec\u30af\u30c8URL\u306b`urn:ietf:wg:oauth:2.0:oob`\u3092\u6307\u5b9a\u3057\u305f\u5834\u5408\u306f\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306aURL\u306b\u30ea\u30c0\u30a4\u30ec\u30af\u30c8\u3055\u308c\u307e\u3059\u3002 \u672b\u5c3e\u306e\u30d1\u30b9\u304c\u8a8d\u53ef\u30b3\u30fc\u30c9\u306b\u306a\u3063\u3066\u3044\u307e\u3059\u3002 ``` https://api.shop-pro.jp/oauth/authorize/AUTH_CODE ``` \u8a8d\u53ef\u30b3\u30fc\u30c9\u306e\u6709\u52b9\u671f\u9650\u306f\u767a\u884c\u304b\u308910\u5206\u9593\u3067\u3059\u3002 \u6700\u5f8c\u306b\u3001\u8a8d\u53ef\u30b3\u30fc\u30c9\u3068\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u3092\u4ea4\u63db\u3057\u307e\u3059\u3002\u4ee5\u4e0b\u306e\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u4ed8\u3051\u3066\u3001`https://api.shop-pro.jp/oauth/token`\u3078\u30ea\u30af\u30a8\u30b9\u30c8\u3092\u9001\u308a\u307e\u3059\u3002 |\u30d1\u30e9\u30e1\u30fc\u30bf\u540d|\u5024| |---|---| |`client_id`|\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u8a73\u7d30\u753b\u9762\u306b\u8868\u793a\u3055\u308c\u3066\u3044\u308b\u30af\u30e9\u30a4\u30a2\u30f3\u30c8ID| |`client_secret`|\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u8a73\u7d30\u753b\u9762\u306b\u8868\u793a\u3055\u308c\u3066\u3044\u308b\u30af\u30e9\u30a4\u30a2\u30f3\u30c8\u30b7\u30fc\u30af\u30ec\u30c3\u30c8| |`code`|\u53d6\u5f97\u3057\u305f\u8a8d\u53ef\u30b3\u30fc\u30c9| |`grant_type`|\\"authorization_code\\"\u3068\u3044\u3046\u6587\u5b57\u5217| |`redirect_uri`|\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u767b\u9332\u6642\u306b\u5165\u529b\u3057\u305f\u30ea\u30c0\u30a4\u30ec\u30af\u30c8URL| ```console # curl \u3067\u306e\u4f8b $ curl -X POST \\ -d'client_id=CLIENT_ID' \\ -d'client_secret=CLIENT_SECRET' \\ -d'code=CODE' \\ -d'grant_type=authorization_code' \\ -d'redirect_uri=REDIRECT_URI' \\ 'https://api.shop-pro.jp/oauth/token' ``` \u30ea\u30af\u30a8\u30b9\u30c8\u304c\u6210\u529f\u3059\u308b\u3068\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306aJSON\u304c\u8fd4\u3063\u3066\u304d\u307e\u3059\u3002 ```json { \\"access_token\\": \\"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX\\", \\"token_type\\": \\"bearer\\", \\"scope\\": \\"read_products write_products\\" } ``` \u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u306b\u6709\u52b9\u671f\u9650\u306f\u3042\u308a\u307e\u305b\u3093\u304c\u3001\u8a31\u53ef\u6e08\u307f\u30a2\u30d7\u30ea\u30b1\u30fc\u30b7\u30e7\u30f3\u4e00\u89a7\u753b\u9762\u304b\u3089\u5931\u52b9\u3055\u305b\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\u306a\u304a\u3001\u540c\u3058\u8a8d\u53ef\u30b3\u30fc\u30c9\u3092\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u306b\u4ea4\u63db\u3067\u304d\u308b\u306e\u306f1\u5ea6\u3060\u3051\u3067\u3059\u3002 \u53d6\u5f97\u3057\u305f\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u306f\u3001Authorization\u30d8\u30c3\u30c0\u306b\u5165\u308c\u3066\u4f7f\u7528\u3057\u307e\u3059\u3002\u4ee5\u4e0b\u306b\u30b7\u30e7\u30c3\u30d7\u60c5\u5831\u3092\u53d6\u5f97\u3059\u308b\u969b\u306e\u4f8b\u3092\u793a\u3057\u307e\u3059\u3002 ```console # curl\u306e\u4f8b $ curl -H 'Authorization: Bearer d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX' https://api.shop-pro.jp/v1/shop.json ``` ## \u30a8\u30e9\u30fc \u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7API v1\u3067\u306f - \u30a8\u30e9\u30fc\u30b3\u30fc\u30c9 - \u30a8\u30e9\u30fc\u30e1\u30c3\u30bb\u30fc\u30b8 - \u30b9\u30c6\u30fc\u30bf\u30b9\u30b3\u30fc\u30c9 \u306e\u914d\u5217\u3067\u30a8\u30e9\u30fc\u3092\u8868\u73fe\u3057\u307e\u3059\u3002\u4ee5\u4e0b\u306b\u4f8b\u3092\u793a\u3057\u307e\u3059\u3002 ```json { \\"errors\\": [ { \\"code\\": 404100, \\"message\\": \\"\u30ec\u30b3\u30fc\u30c9\u304c\u898b\u3064\u304b\u308a\u307e\u305b\u3093\u3067\u3057\u305f\u3002\\", \\"status\\": 404 } ] } ``` # noqa: E501", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "OpenAPI,OpenAPI-Generator,\u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7 API", "license": "", "maintainer": "", "maintainer_email": "", "name": "colormeshop", "package_url": "https://pypi.org/project/colormeshop/", "platform": "", "project_url": "https://pypi.org/project/colormeshop/", "project_urls": null, "release_url": "https://pypi.org/project/colormeshop/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "\u30ab\u30e9\u30fc\u30df\u30fc\u30b7\u30e7\u30c3\u30d7 API", "version": "1.0.0" }, "last_serial": 4113207, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "cd473d01b1b3db5b069454bab1ef3d86", "sha256": "62263adef2e39bf7f84bda8eaffe0457f562a3d9eb08b95f114ccf87e27d1cc7" }, "downloads": -1, "filename": "colormeshop-1.0.0-py3.6.egg", "has_sig": false, "md5_digest": "cd473d01b1b3db5b069454bab1ef3d86", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 523835, "upload_time": "2018-07-29T08:04:27", "url": "https://files.pythonhosted.org/packages/5b/1c/e7f330a5c44843b8c0abb14353a5844108e5a6073a91763501d2964b5306/colormeshop-1.0.0-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "6a62770c1d499b8aec06bc7ed13a893e", "sha256": "ebceb170dd29bcc8e342163ad842d694d9e92eba8f27356e8578508484515da1" }, "downloads": -1, "filename": "colormeshop-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6a62770c1d499b8aec06bc7ed13a893e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 74323, "upload_time": "2018-07-29T08:04:30", "url": "https://files.pythonhosted.org/packages/33/5a/5773f74000a13ea5efa506a9c65ac2a6984e2bac5e2f79adefbba91af54c/colormeshop-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cd473d01b1b3db5b069454bab1ef3d86", "sha256": "62263adef2e39bf7f84bda8eaffe0457f562a3d9eb08b95f114ccf87e27d1cc7" }, "downloads": -1, "filename": "colormeshop-1.0.0-py3.6.egg", "has_sig": false, "md5_digest": "cd473d01b1b3db5b069454bab1ef3d86", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 523835, "upload_time": "2018-07-29T08:04:27", "url": "https://files.pythonhosted.org/packages/5b/1c/e7f330a5c44843b8c0abb14353a5844108e5a6073a91763501d2964b5306/colormeshop-1.0.0-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "6a62770c1d499b8aec06bc7ed13a893e", "sha256": "ebceb170dd29bcc8e342163ad842d694d9e92eba8f27356e8578508484515da1" }, "downloads": -1, "filename": "colormeshop-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6a62770c1d499b8aec06bc7ed13a893e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 74323, "upload_time": "2018-07-29T08:04:30", "url": "https://files.pythonhosted.org/packages/33/5a/5773f74000a13ea5efa506a9c65ac2a6984e2bac5e2f79adefbba91af54c/colormeshop-1.0.0.tar.gz" } ] }