API Docs
Message APIManagement API
Message APIManagement API
xID for Developers
SmartPOST 管理画面
  1. project
  • SmartPOST Management API 概要
  • 用語定義
  • project
    • listProjects
      GET
    • getProject
      GET
    • listImageUrls
      GET
    • listProjectRecipients
      GET
    • listProjectVariables
      GET
  • admin
    • listAdmins
      GET
    • getAdmin
      GET
  • custom policy
    • listCustomPolicies
      GET
    • getCustomPolicy
      GET
  • custom role
    • listCustomRoles
      GET
    • getCustomRole
      GET
  • group
    • listGroups
      GET
    • getGroup
      GET
  • health
    • healthCheck
      GET
  1. project

getProject

GET
/v1/projects/{id}
listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクト(Welcomeプロジェクト、テンプレートも含む)の詳細情報を取得できます。
情報
message_bodyについては、プレビュー用途で使われる想定で提供されます。
カスタム変数等、受信者によって異なるものについては、設定されている受信者に設定されている値の中からピックアップされたもの、もしくはサンプル値が含まれます。
また、SmartPOSTでデフォルトとして提供しているCSSを利用いただくことを想定しています。
https://public.smartpost.jp/styles/v1/style.css

リクエストパラメータ

Authorization
Headerにパラメータ
Authorization
を追加し、その値にはBasicの後にスペースと、Base64でエンコードされたusername:passwordが連結されます
例:
Authorization: Basic *****************
パスパラメータ

Headerパラメータ

リクエストコードサンプル

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
リクエストリクエストExample
Shell
JavaScript
Java
Swift
curl --location 'https://management-api.smartpost.jp/v1/projects/00000000-0000-0000-0000-102101ec7001' \
--header 'Accept: application/json' \
--header 'Host: management-api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
--header 'Authorization: Basic <encoded-value>'

レスポンス

🟢200Success
application/json
ボディapplication/json

例
{
    "id": "00000000-0000-0000-0000-acc000000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "title": "sample title",
    "message_title": "sample message title",
    "message_body": "<div class=\"smartpost-api-exported-content\"><p>example message body</p></div>",
    "image_ids": [
        "00000000-0000-0000-0000-acc000000001"
    ],
    "is_set_recipient": true,
    "is_set_content": true,
    "is_set_approver": true,
    "is_set_schedule": true,
    "schedule": 1667899934,
    "created_by": "00000000-0000-0000-0000-acc000000001",
    "created_at": 1667899934,
    "updated_by": "00000000-0000-0000-0000-acc000000001",
    "updated_at": 1667899934,
    "sent_to_all_recipients_at": 1667899934,
    "all_approved_at": 1667899934,
    "type": "normal",
    "categories": [
        1
    ],
    "permitted_groups": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample group"
        }
    ],
    "prefecture": "黒須県",
    "city": "黒須市",
    "version": "v2",
    "pdf_ids": [
        {
            "pdf_id": "00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002",
            "file_name": "sample.pdf",
            "is_individual_id": true
        }
    ]
}
🟠400Bad Request
🟠404Not Found
🟠401Unauthorized
更新日時 2025-03-27 01:11:41
前へ
listProjects
次へ
listImageUrls
Built with