API docs by Redocly

Re:paint API (2.0.0)

Download OpenAPI specification:Download

License: MIT

API for Re:paint

admin

API for administrators

send email

イベントの管理者を追加するためのメールを送信する

Authorizations:
bearerAuth
Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

email
required
string <email>

追加する管理者のメールアドレス

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "email": "user@example.com"
}

add operator

イベントの管理者を追加する

Authorizations:
bearerAuth
Request Body schema: application/json
required
token
required
string

emailに添付されているURLの末尾にクエリパラメータとして付与されているtoken

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

create event

イベントを作成する

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

イベント名

hpUrl
required
string

イベントのホームページのURL

required
object (Contact)

イベントの責任者情報

name
required
string

イベントの責任者の名前

email
required
string <email>

イベントの責任者のメールアドレス

phone
required
string

イベントの責任者の電話番号

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hpUrl": "string",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "eventId": "string",
  • "name": "string",
  • "hpUrl": "string",
  • "contact": {
    }
}

delete event

イベントを削除する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Responses

get event list

管理者に紐づくイベントの一覧を取得する

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update event

イベントを更新する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
name
required
string

イベント名

hpUrl
required
string

イベントのホームページのURL

required
object (Contact)

イベントの責任者情報

name
required
string

イベントの責任者の名前

email
required
string <email>

イベントの責任者のメールアドレス

phone
required
string

イベントの責任者の電話番号

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hpUrl": "string",
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "eventId": "string",
  • "name": "string",
  • "hpUrl": "string",
  • "contact": {
    }
}

register default image

デフォルトで登録される画像を設定する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: multipart/form-data
required
image
required
string <binary>

画像ファイル

Responses

delete default image

デフォルトで登録されている画像を削除する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
imageId
required
string (eventImageID)

イベントのデフォルト画像のID(ulid)

Responses

Request samples

Content type
application/json
{
  • "imageId": "string"
}

check visitor image is exist

参加者を撮影した画像を取得する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

query Parameters
visitorId
required
string (visitorID)

参加者のパブリックID

Responses

Response samples

Content type
application/json
{
  • "imageId": "string"
}

upload visitor image

参加者を撮影した画像を登録する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: multipart/form-data
required
image
required
string <binary>

画像ファイル

Responses

image update notification

画像処理が完了したことを通知する

path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
visitorId
required
string (visitorID)

参加者のパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "visitorId": "string"
}

get image url by image id

管理者がimage idから写真のURLを取得する

path Parameters
eventID
required
string (eventID)

イベントのパブリックID

query Parameters
eventImageId
required
string (eventImageID)

イベントのデフォルト画像のID

Responses

Response samples

Content type
application/json
{}

register spot

スポットを登録する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
name
required
string

スポット名

hwId
required
string

ビーコンのハードウェアID

serviceUuid
required
string

ビーコンのサービスUUID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hwId": "string",
  • "serviceUuid": "string"
}

Response samples

Content type
application/json
{
  • "spotID": "string",
  • "name": "string",
  • "beacon": {
    },
  • "isPick": true,
  • "bonus": true
}

check spot status by beacon hwId

hwIdを指定してスポットを取得する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

query Parameters
hwId
required
string (hwID)

ビーコンのハードウェアID

Responses

Response samples

Content type
application/json
{
  • "spotID": "string",
  • "name": "string",
  • "beacon": {
    },
  • "isPick": true,
  • "bonus": true
}

check spot status by QR code(spotId)

QRコード(spotId)を指定してスポットを取得する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

query Parameters
spotId
required
string (spotID)

スポットのパブリックID

Responses

Response samples

Content type
application/json
{
  • "spotID": "string",
  • "name": "string",
  • "beacon": {
    },
  • "isPick": true,
  • "bonus": true
}

get spot list

スポットの一覧を取得する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update spot

スポットを更新する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
spotId
required
string (spotID)

スポットのパブリックID(ulid)

name
required
string

スポット名

isPick
required
boolean

pickableなスポットかどうか

Responses

Request samples

Content type
application/json
{
  • "spotId": "string",
  • "name": "string",
  • "isPick": true
}

Response samples

Content type
application/json
{
  • "spotID": "string",
  • "name": "string",
  • "beacon": {
    },
  • "isPick": true,
  • "bonus": true
}

delete spot

スポットを削除する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
spotId
required
string (spotID)

スポットのパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "spotId": "string"
}

get traffic status

イベントの人流を取得する

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
{
  • "traffics": [
    ]
}

enable bonus

人流制御を有効にする(ボーナスを有効にする)

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
from
string (spotID)

スポットのパブリックID(ulid)

to
required
string (spotID)

スポットのパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "to": "string"
}

disable bonus

人流制御を無効にする(ボーナスを無効にする)

Authorizations:
bearerAuth
path Parameters
eventID
required
string (eventID)

イベントのパブリックID

Request Body schema: application/json
required
spotId
required
string (spotID)

スポットのパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "spotId": "string"
}

visitor

API for visitors

get visitor image list

参加者に紐づくグレースケールの写真の一覧を取得する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

query Parameters
eventId
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
{}

get current image

参加者が現在設定している写真を取得する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

query Parameters
eventId
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
{
  • "imageId": "string"
}

set current image

参加者の画像を設定する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

imageId
required
string (visitorImageID)

参加者が撮影した画像のID(ulid)

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "imageId": "string"
}

get image url by image id

参加者がimage idから写真のURLを取得する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

query Parameters
eventId
required
string (eventID)

イベントのパブリックID

visitorImageId
required
string (visitorImageID)

参加者が撮影した画像のID

Responses

Response samples

Content type
application/json
{}

Check for updates to an image

画像に更新があるか確認する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

query Parameters
eventId
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
{
  • "isUpdated": true
}

pick palette

paletteをpickする

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

spotId
required
string (spotID)

スポットのパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "spotId": "string"
}

Get is complete palette

パレットを取得し切ったかどうかを返す

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

query Parameters
eventId
required
string (eventID)

イベントのパブリックID

Responses

Response samples

Content type
application/json
{
  • "isCompleted": true
}

scanned spot

spotをスキャンしたことを記録する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

hwId
required
string (hwID)

ビーコンのハードウェアID

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "hwId": "string"
}

Response samples

Content type
application/json
{
  • "isBonus": true
}

join event

イベントに参加する

Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

registrationId
required
string (registrationID)

スマホのプッシュ通知用のID

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "registrationId": "string"
}

Response samples

Content type
application/json
{
  • "visitor": {
    },
  • "event": {
    }
}

initialize visitor(Second and subsequent startups)

参加者を初期化する(二回目以降の起動時)

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

Request Body schema: application/json
required
eventId
required
string (eventID)

イベントのパブリックID(ulid)

registrationId
required
string (registrationID)

スマホのプッシュ通知用のID

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "registrationId": "string"
}

Response samples

Content type
application/json
{
  • "visitor": {
    },
  • "event": {
    }
}

delete visitor

参加者を削除する

path Parameters
visitorID
required
string (visitorID)

参加者のパブリックID

Request Body schema: application/json
required
eventID
required
string (eventID)

イベントのパブリックID(ulid)

Responses

Request samples

Content type
application/json
{
  • "eventID": "string"
}

auth

API for authentication

register admin

管理者を作成し、システムに登録する

Request Body schema: application/json
required
subject
required
string

Auth0のuser profileのuser_id

Responses

Request samples

Content type
application/json
{
  • "subject": "string"
}