Warning! Construction underway! Amatino is in an 'alpha' state. Not all features are operational. See roadmap

Primary
Account
Entity
Transaction
Derived
Balance
Ledger
Performance
Position
Recursive Balance
Recursive Ledger
Tree
Ancillary
Custom Unit
Entry
Global Unit
Global Unit List
Ledger Row
Session
Side
Tx Version List
Tree Node
Type
Object
Create
Retrieve
Delete

User

A User is a human producer and consumer of data stored by Amatino. When you create an Amatino account on this website, a User is generated in your name. You can create other Users at will to serve the needs of your application. For example, you might wish to create an Amatino User to associate with each end-user of your application, in order to link financial information stored in Amatino with that end-user.

Users created via the Amatino API cannot login or otherwise interact with the amatino.io website in any way. They are not eligbile to receive customer support from us directly (though you are most welcome to request customer support to assist you with users you create), and don't generate associated discussion forum accounts. You have absolute control over their lifecycle. They can make requests to the Amatino API on their own behalf.

Generally, if you are creating User accounts for your fellow developers, you will want to do so in your billing dashboard. Doing so will allow them to manage their password, post to the discussion forums, and contact us for support. If you are creating Users to manage financial data inside your application, you will want to do so via the Amatino API.

Users and Entities are woven together using permission graphs. Any User may be granted read and or write access to any Account in any Entity, whether they were created in the billing dashboard or via the Amatino API.

If you are on a Fixed Price plan, each additional user you create in the Amatino API will count towards your monthly bill. If you are on a Pay Per Use plan, creating additional Users incurs no direct marginal cost. You can change your plan at any time.

The User Object

When returning a User to you, Amatino uses the following JSON object structure.

Root Type

JSON Array

Object Structure

description An identifier for this user that is unique across all of Amatino
key "user_id"
example 95348572
type JSON Number
description The email address associated with this User, if one exists
key "email"
example hugh@amatino.io
type JSON String or JSON Null
description A long form name associated with this User, if one exists
key "name"
example John Young
type JSON String or JSON Null
description A short form name associated with this User, if one exists
key "handle"
example "Gemini 3"
type JSON String or JSON Null
description A url to a JPEG image avatar associated with this User, if one exists
key "avatar_url"
example "https://content.amatino.io/avatars/orion.jpg"
type JSON String

Create User

API Path /users
HTTP Method POST
Description Descr. Create a new entity or entities

Required Headers

Key X-Signature
Value Your Session signature
Example "yxATCPRKAAXHNiPctNQPHEGGVJF"...
Key X-Session-ID
Value An an integer Session ID
Example 7449059267091272858

Required URL Parameters

Required JSON Data

Root type

JSON Array

Max Array Length

10

Object Structure

max char length 512
description An optional long form text identifier for the User
key "name"
example "Chris Hemsworth"
type JSON String or JSON Null
max char length 512
description An optional short form text identifier for the User
key "handle"
example "Thor"
type JSON String or JSON Null
description A secret string to authenticate Session requests for the User
requirement 1 Must not include the word 'password'
example "jPN6GQxVSTBQXMgwODaR/A"
key "secret"
min length 12
max length 100
requirement 2 Must include at least 4 unique characters
type JSON String

Returns

Root Type

JSON Array

Object

User

Retrieve User

API Path /user
HTTP Method GET
Description Descr. Retrieve a user or users

Required Headers

Key X-Signature
Value Your Session signature
Example "yxATCPRKAAXHNiPctNQPHEGGVJF"...
Key X-Session-ID
Value An an integer Session ID
Example 7449059267091272858

Required URL Parameters

Key user_id
Type integer number
Description Descr. The user id of the User you wish to retrieve. Omit entirely to retrieve the authenticated user
Example 67892385239
Repeatable Yes

Required JSON Data

Root type

Object Structure

Returns

Root Type

JSON Array

Object

User

Delete User

API Path /user
HTTP Method DELETE
Description Descr. Permanently and irrecoverably delete a user or users

Required Headers

Key X-Signature
Value Your Session signature
Example "yxATCPRKAAXHNiPctNQPHEGGVJF"...
Key X-Session-ID
Value An an integer Session ID
Example 7449059267091272858

Required URL Parameters

Key entity_id
Type string
Description Descr. The user id you wish to permanently and irrecoverably delete
Example oB3cjSNKXklkJ4Tb
Repeatable No

Required JSON Data

None.

Returns

Root Type

JSON Array

Object

User