👤
User
This equals a user account in Pixela. First of all, you have to register your
User to use Pixela.Related APIs
- POST - /v1/users
- This is an API for registering a new
User.
- PUT - /v1/users/<username>
- This is an API for updating an existing
User.
- DELETE - /v1/users/<username>
- This is an API for deleting an existing
User.
Properties and features
User has the following properties:token
username
agreeTermsOfService
notMinor
thanksCode
token
This equals a password of the user account. When you use various APIs as the user account, you need to specify the
token in the header of the API request with X-USER-TOKEN as the key.If you forget your
token , it can not be revoked or reissued. For more details, please see I’ve forgotten my token. What should I do?.username
This is your name as a Pixela user. This is also used as part of URL when you display your Pixela graphs, for example. You can not register a
User with username that is already used.agreeTermsOfService
You specify
yes or no about whether you agree with Pixela’s terms of Service in this property. If you do no , then you can not use Pixela.notMinor
You specify
yes or no about that you are not a minor in this property. If you are a minor, then you can not use Pixela.thanksCode
This is a property that you can set the registration code called
thanks-code . If you set a valid thanks-code in this property, then all the limitations for features will be removed. For more details, please see Make exclusive features available as a benefit of supporting Pixela - Pixela Supporter Program.Specifications
- When you delete a
User, all data, such as graphs, associated with it also will be deleted.
Notes
- If you let a person register
Userof Pixela by integrating Pixela’s API into your service, for example, please make sure that the person agrees to Pixela’s terms of Service and confirms that he or she is not a minor.
- You can register more than one
User. You can use onethanks-codeto more than oneUsers. - If you want to share your
thanks-codewithUsers in your organization, please register your support as Logo/Icon sponsor membership level. For more details, please see Place your logo or icon on Pixela toppage.