👤

User

Pixela のユーザーアカウントに相当するものです。Pixela を使うためには、まず User を登録する必要があります。

関連API

特徴

User には、以下のようなプロパティがあります。
  • token
  • username
  • agreeTermsOfService
  • notMinor
  • thanksCode

token

そのユーザーアカウントに対するパスワードのようなものです。そのユーザーアカウントとして様々なAPIを利用する際に、そのリクエストヘッダに X-USER-TOKEN をキーに token を指定する必要があります。
token を別のものに変更したい場合は、PUT - /v1/users/<username> を利用してください。
token を忘れた場合でもリセットや再発行などを行うことはできません。詳しくは 🆘tokenを忘れてしまいました。どうすればいいですか? を参照してください。

username

ユーザー名です。Pixela のグラフなどを表示させる際に、URLの一部としても使われます。既に使用されているものと同じものを指定して User を登録することはできません。また、後から変更することはできません。

agreeTermsOfService

Pixela の利用規約に同意するかどうかを yes no で指定します。同意しない場合、Pixela を利用することはできません。

notMinor

利用者が未成年ではないことを yes no で指定します。あなたが未成年の場合、Pixela を利用することはできません。

thanksCode

thanks-code と呼ばれるレジストレーションコードを設定できるプロパティです。このプロパティに有効な thanks-code を設定すると、すべての機能の制限が解除されます。詳しくは 💝Pixela を支援する特典として限定機能を利用可能にする - Pixela サポータープログラム を参照してください。
 

仕様

  • Userを削除すると、それに紐付くグラフなどのすべての情報も削除されます。

留意事項

  • あなたが Pixela の API をあなたのサービスに組み込むなどして、第三者に Pixela の User を登録させる場合、利用規約の同意と未成年ではないことの確認はその第三者に対して行うようにしてください。
  • 複数の User を登録しても構いません。複数の User に対してひとつの thanks-code を登録することができます。

関連リンク