{"info":{"_postman_id":"e75161c8-a6a0-4a21-9767-f8f1a35728a1","name":"UPBOND API Reference","description":"

APIリファレンス概要

UPBONDの提供する機能のいくつかは、他のシステムと連携できるようにAPIを公開しています。

共通処理

各種機能を利用するためにはユーザーに関連付けられたAPIトークン( {{token}} )を利用する必要があり、 Authentication -> authorize(login) へのリクエスト結果より得られたAPIトークンをリクエストヘッダに追記する必要があります。

注意事項

以下の内容に関して注意してご利用下さい。

APIが利用可能となるユーザーは、アカウントが有効である必要があります。無効化されたアカウントでは同時にAPI機能も利用できなくなります。
公開されているAPIに関してRate Limitは定めていませんが、ご利用状況によって告知の上、レートの制限を実施する可能性がございます。

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"APIリファレンス概要","slug":"api"}],"owner":"10725961","collectionId":"e75161c8-a6a0-4a21-9767-f8f1a35728a1","publishedId":"Szzn6boA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-24T04:00:30.000Z"},"item":[{"name":"Authentication","item":[{"name":"get personal information","event":[{"listen":"test","script":{"id":"2be522e4-29ff-4a0c-9f54-cdd4ec986302","exec":["var data = JSON.parse(responseBody);","tests[\"成功\"] = pm.response.code === 200;","if (pm.response.to.have.status(200)) {"," postman.setEnvironmentVariable(\"userId\",data._id);","}"],"type":"text/javascript"}}],"id":"37ce2c67-2248-46b3-8bdc-9b4a87df4399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/oauth/personal-information","description":"

リクエストユーザーに関する情報を取得します。

\n","urlObject":{"protocol":"https","path":["oauth","personal-information"],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"37ce2c67-2248-46b3-8bdc-9b4a87df4399"},{"name":"authorize(login)","event":[{"listen":"test","script":{"id":"09aa93ff-bc17-458d-b484-ca22f851cd5c","exec":["var data = JSON.parse(responseBody);","tests[\"成功\"] = pm.response.code === 200;","if (pm.response.to.have.status(200)) {"," postman.setEnvironmentVariable(\"token\", data.accessToken);"," postman.setEnvironmentVariable(\"accountId\", data.accounts[0].id);"," postman.setEnvironmentVariable(\"account_id\", data.accounts[0].id);"," postman.setEnvironmentVariable(\"api_key\", data.api_key[0]);","}"],"type":"text/javascript"}}],"id":"5ad39d24-7046-4144-abd4-836bc9707725","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"{{email}}\",\n \"password\": \"{{password}}\"\n}"},"url":"https://api.upbond.io/oauth/login","description":"

アクセストークンを取得するため、メールアドレスとパスワードを用いてログインを行います。
レスポンスデータの token に与えられた値が、そのユーザーから各種APIにアクセスするためのトークンとなります。

\n","urlObject":{"protocol":"https","path":["oauth","login"],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ad39d24-7046-4144-abd4-836bc9707725"}],"id":"d3d66a1f-5181-4d37-aba6-2572abf5b957","description":"

リクエストに必要なAPIキーの取得や、リクエスト元のアカウントに関する情報を取得します。

\n","event":[{"listen":"prerequest","script":{"id":"a952399f-f6a4-4d94-b604-b20587b32920","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b52182e-2d19-416a-8e9d-7aa3da982bd9","type":"text/javascript","exec":[""]}}],"_postman_id":"d3d66a1f-5181-4d37-aba6-2572abf5b957"},{"name":"Campaign","item":[{"name":"get campaign list","id":"43b393a4-f34a-4b93-a9e4-8cb9be2be3b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/campaigns/","description":"

アカウントに紐付いたキャンペーン一覧を取得します。

\n","urlObject":{"protocol":"https","path":["campaigns",""],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"43b393a4-f34a-4b93-a9e4-8cb9be2be3b7"}],"id":"ae16ad94-c551-4018-b117-831fc03a74d2","description":"

キャンペーン機能に関するAPI

\n","event":[{"listen":"prerequest","script":{"id":"a60371f6-9214-4ac3-916d-99c959642bc1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"034a2ea7-1d79-4d47-a4fc-bc2662e84855","type":"text/javascript","exec":[""]}}],"_postman_id":"ae16ad94-c551-4018-b117-831fc03a74d2"},{"name":"Customer","item":[{"name":"get customer list","event":[{"listen":"test","script":{"id":"217c5b48-ddda-40d9-ba0f-812d573d2351","exec":["var data = JSON.parse(responseBody);","tests[\"成功\"] = pm.response.code === 200;","if (pm.response.to.have.status(200)) {"," postman.setEnvironmentVariable(\"customerId\", data.data[0].id);","}"],"type":"text/javascript"}}],"id":"9aa273b0-e7bc-46fa-8417-45179ebc9a36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"account_id","value":"{{account_id}}","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/customers/","description":"

アカウントに関連付いた顧客の一覧を取得します。

\n","urlObject":{"protocol":"https","path":["customers",""],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9aa273b0-e7bc-46fa-8417-45179ebc9a36"},{"name":"get customer detail","id":"a98ee5f4-06bf-4b13-b4d8-0e1d336c43f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/customers/{{customerId}}","description":"

指定された顧客IDに対応する顧客の情報を取得します。

\n","urlObject":{"protocol":"https","path":["customers","{{customerId}}"],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a98ee5f4-06bf-4b13-b4d8-0e1d336c43f9"},{"name":"get customer activities","id":"20b292f6-0f06-4640-ad91-1be7411c1311","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/customers/{{customerId}}/activities","description":"

指定された顧客IDに対応する顧客の行動データを取得します。

\n","urlObject":{"protocol":"https","path":["customers","{{customerId}}","activities"],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"20b292f6-0f06-4640-ad91-1be7411c1311"}],"id":"4f396ce3-6909-47df-b9c2-de1952ef2783","description":"

アカウントに紐付いたCustomerに関するAPI

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"07a45893-f69f-4564-90f6-e2b75da85221","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71520339-bbf1-4ed0-9d77-78459b320e69","type":"text/javascript","exec":[""]}}],"_postman_id":"4f396ce3-6909-47df-b9c2-de1952ef2783"},{"name":"Segmentation","item":[{"name":"get segmentaion list","id":"a984ae43-bf8c-4337-a604-6fc74ba63d30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/campaigns/segmentations/","description":"

作成されたセグメンテーションの一覧を取得します。

\n","urlObject":{"protocol":"https","path":["campaigns","segmentations",""],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a984ae43-bf8c-4337-a604-6fc74ba63d30"},{"name":"get segmentation result","id":"da5e1d9f-1a54-4108-b043-bc0a3c587cd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.upbond.io/campaigns/segmentations/{{segmentationId}}/execute","description":"

指定されたセグメンテーションIDに関して、該当する顧客の人数をリアルタイムで集計します。

\n","urlObject":{"protocol":"https","path":["campaigns","segmentations","{{segmentationId}}","execute"],"host":["api","upbond","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"da5e1d9f-1a54-4108-b043-bc0a3c587cd7"}],"id":"bf4e8bc6-8180-4ba3-97c4-1dec30701530","_postman_id":"bf4e8bc6-8180-4ba3-97c4-1dec30701530","description":""}],"event":[{"listen":"prerequest","script":{"id":"8229db4d-2bb8-4f59-9efc-40c4c60fee93","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b96e017e-a7ed-4ae3-9b19-51074bd99548","type":"text/javascript","exec":[""]}}]}