mossByte - API v1 Documentation

Create POST /{application_key}

This will create a new mossByte record for storing a JSON object.
You provide the {application_key} in the URI, this makes up part of the authorisation to create a new mossByte and you must first obtain an application key.

Request ( BODY )

{
	"object": [
		{
			"string_key": "abcd",
			"number_key": 500,
			"boolean_key": false,
			"datetime_key": "2017-07-01 14:59:59"
		}
	],
	"keys": {
		"read": [ // These keys are used to read the object via a GET request
			{
				"key": "{unique_36_char_string}", // Note: Must be unique to each other key for the chosen action, Must be a minimum of 36 and a maximum of 128 characters in length. Also must be alphanumeric only with the only special character exceptions being a spaces, underscores and dashes.
				"label": "{36_char_string_label}", // Note: Must be a minimum of 5 and a maximum of 36 characters in length. Also must be alphanumeric only with the only special character exceptions being a spaces, underscores and dashes.
			},
			...
		],
		"admin": [ // These keys are used to write and delete the object via PUT, PATCH and DELETE requests
			{
				"key": "{unique_36_char_string}",
				"label": "{36_char_string_label}",
			},
			...
		]
	}
}

key	required	description
object	yes	You provide your JSON object as part of the body payload under the key "object", this allows you to create a new mossByte and populate its initial data if desired.
keys	optional	You can optionally define an array of keys to a maximum of 10 keys per action. !IMPORTANT We strongly recommend that you generate your unique keys using a solid GUID library and textareafix any UDID keys with a unique identifier that secretly retextareasents your application ( not the Application Key ) as basic keys that can be easily replicated by other people will allow them to deduce your keys and exploit your data.

Response ( BODY )

{
	"status": true,
	"message": "mossByte successfully created",
	"data": {
		"mossByte": {
			"id": "bcce730c13184e29b10...",
			"keys": {
				"read": [
					{
						"key": "{unique_36_char_string}",
						"label": "{36_char_string_label}",
					},
					...
				],
				"admin": [
					{
						"key": "{unique_36_char_string}",
						"label": "{36_char_string_label}",
					},
					...
				]
			}
		}
	}
}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data.mossByte	object containing the identifier and keys for the newly created mossByte object.
data.mossByte.keys	keys contains a default key for each possible access to the mossByte, its important that these keys be recorded and accessible to those who are needing access as you cannot retrieve them once you dispose of your response.

Select GET /{read_key}

This will return a mossByte record which contains the current version of the JSON object.
You provide the {read_key} in the URI, this validates your access and looks up the mossByte record.

Response ( BODY )

{
	"status": true,
	"message": "mossByte successfully returned",
	"data": {
		"mossByte": {
			"id": "bcce730c13184e29b10...",
			"object": [
				{
					"string_key": "abcd",
					"number_key": 500,
					"boolean_key": false,
					"datetime_key": "2017-07-01 14:59:59"
				}
			]
		}
	}
}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data.mossByte	Contains the identifier and object for the requested mossByte.
data.mossByte.id	id is the unique id for that mossByte ( this is not its read key )
data.mossByte.object	This is the rendered mossByte object either as the static stored values you provided or generated relational referenced values or objects.

Raw GET /{admin_key}

This will return a raw mossByte record which contains the current version of the JSON object but with no dynamic value loading, you would use this to textareaview the object or retrieve the object for manipulation and then PUT the object back in its raw state. The other GET method does not include the raw flag and this means it will output the object after any dynamic value lookups of other mossByte's are parsed and injected
You provide the {admin_key} in the URI, this validates your access and looks up the mossByte record for its raw value.
The reason why this GET requires the {admin_key} instead of the {read_key} is because the raw object may contain {read_key}'s for other mossBytes and this would pose a risk to the owner of the current mossByte where their intention was to provide the current mossByte's {read_key} for viewing this mossByte only and not the others which may make up this mossByte.
Relational referencing is when you store a specific macro value at a key and structure it to insert a value or partial/full object from either the same or another mossByte object. This is useful for having dynamic and reuseable content stextareaad over many objects with a single point of change.

Response ( BODY )

{
	"status": true,
	"message": "mossByte successfully returned",
	"data": {
		"mossByte": {
			"id": "bcce730c13184e29b10...",
			"object": [
				{
					"string_key": "abcd {##read_key:object_key:cast_type##}",
					"number_key": 500,
					"boolean_key": false,
					"datetime_key": "2017-07-01 14:59:59"
				}
			]
		}
	}
}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data.mossByte	Contains the identifier and raw object for the requested mossByte.
data.mossByte.id	id is the unique id for that mossByte ( this is not its read key )
data.mossByte.object	A raw object is one that returns relationship references without converting the reference to the related value or object data, you use this raw GET method for viewing the mossByte data for editing the relational references.

Update PUT /{admin_key}

This will update a mossByte record and return the JSON object after its updated.
You provide the {admin_key} in the URI, this validates your access and looks up the mossByte record.

Request ( BODY )

{
	"object": [
		{
			"string_key": "abcdefg",
			"number_key": 1500,
			"boolean_key": true,
			"datetime_key": "2017-12-15 05:29:19"
		}
	]
}

key	required	description
object	yes	You also provide your revised JSON object as part of the body payload under the key "object", this allows you to update an existing mossByte object data.

Response ( BODY )

{
	"status": true,
	"message": "mossByte successfully updated",
	"data": null
	}
}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data	Remains null as you just PUT the structure and should know the structure, this is to reduce the data traffic for large objects.

Destroy DELETE /{admin_key}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data.mossByte	Contains the identifier and raw object for the requested mossByte.
data.mossByte.id	id is the unique id for that mossByte ( this is not its read key )
data.mossByte.object	This will be null as the mossByte is now deleted.

Modify PATCH /{admin_key}

Use this endpoint to modify specific keys within the JSON object structure, you deliver a series of instructions that perform different functions over the defined dot separated keys for the provided modifier values. You can even reference another key within the either the same mossByte object as your new value or even reference a different mossByte object by defining its {read_key} along with the {object_key}
Attention: The Modify endpoint is currently free for all to use but soon will be part of our paid model which allows extra functionality beyond POST, GET, PUT and DELETE. We encourage you to test out this function and know that we are wanting to look for a simple and low price paid model for this feature. You provide the {admin_key} in the URI, this validates your access and looks up the mossByte record.

Request ( BODY )

{
	"rollback": false,
	"instructions": [
		{
			"function": "set",
			"key": "string_key",
			"value": "lmnop"
		},
		{
			"function": "append", // Note: that you can append or textareapend strings with static or dynamic values
			"key": "string_key",
			"value": " {%%number_key%%}" // Note: that this is referencing another key in the JSON object to be appended to the defined key on this instruction. The {%% %%} braces indicate a value lookup based on the keys
		},
		{
			"function": "divide", // Note: simple math functions allow for easy modification of a value at a specific key
			"key": "number_key",
			"value": 500
		},
		{
			"function": "divide",// Note: that most functions require a value, this instruction will fail.
			"key": "number_key"
		},
		{
			"function": "append",
			"key": "string_key",
			"value": " {%%number_key%%}" // Note: that this is referencing another key in the JSON object to be appended to the defined key on this instruction. The {%% %%} braces indicate a value lookup based on the keys
		},
		{
			"function": "toggle", // Note: that a simple toggle function on a boolean type makes for quick and easy changes to the state of a stored key
			"key": "boolean_key"
		},
		{
			"function": "days", // Note: that date time functions are just an indication to what you are modifying and the value can be signed to either add or sub from the date based on that indicated property.
			"key": "datetime_key",
			"value": 5
		},
		{
			"function": "append",
			"key": "string_key",
			"value": " {%%read_key:number_key%%}" // Note: that this is not only referencing another key but specifically another key in another mossByte. The {%% %%} braces indicate a value lookup based on the keys
		},
	]
}

key	required	description
rollback	optional	If set to true then any single error with an instruction will cause the whole stack of instructions to fail and roll back to their original state. ( some of the dynamic values do not fail and instead just return blanks )
instructions	yes	Here you provide a json structured array of instructions, see below for examples and for a full list of functions and behaviours scroll to the bottom.

Functions

function	parameters	behaviour
set	key: {string\|int} value: {string\|int\|float\|bool\|array\|object}	key's value gets overwritten with new defined value
unset	key: {string\|int}	key gets overwritten with defined value
append	key: {string\|int} value: {string\|int\|float}	key gets defined value added to the end of key's existing value
prepend	key: {string\|int} value: {string\|int\|float}	key gets defined value added to the start of key's existing value
addition	key: {string\|int} value: {int\|float}	key gets defined value mathematically added to the key's existing value
subtract	key: {string\|int} value: {int\|float}	key gets defined value mathematically subtracted off the key's existing value
multiply	key: {string\|int} value: {int\|float}	key gets defined value mathematically multiplied to the key's existing value
divide	key: {string\|int} value: {int\|float}	key gets defined value mathematically divided on the key's existing value
toggle	key: {string\|int}	if key is of type boolean then this will change the state of the key to its opposite state
yesterday	key: {string\|int} value: {timezone} ( optional, default UTC )	key gets set to the current date and time for yesterday based on the defined or default timezone
now	key: {string\|int} value: {timezone} ( optional, default UTC )	key gets set to the current date and time for now based on the defined or default timezone
tomorrow	key: {string\|int} value: {timezone} ( optional, default UTC )	key gets set to the current date and time for tomorrow based on the defined or default timezone
seconds minutes hours days weeks months years	key: {string\|int} value: {int}	if key is of date and/or time following a parsable format, then the defined number is added to the keys parsed date and time as additional units. ( this supports signed values so you can add a negative integer )
array:clear	key: {string\|int}	the value defined at the key is cleared to be an empty array, regardless of the original value you will get an empty array.
array:add	key: {string\|int} subkey: {string\|int} value: {string\|int\|float\|bool\|array\|object}	the value will be set against the subkey position within the defined keys array
array:remove	key: {string\|int} subkey: {string\|int}	the subkey will be removed from the primary key's array
array:prepend	key: {string\|int} value: {string\|int\|float\|bool\|array\|object}	the defined value will be prepended to the array
array:append	key: {string\|int} value: {string\|int\|float\|bool\|array\|object}	the defined value will be appended to the array
array:slice	key: {string\|int} offset: {int} ( optional if length ) length: {int} ( optional if offset )	this will slice the array from the offset position ( or zero index ) for the length ( or remainder ) of the items in the array.
array:sort	key: {string\|int} direction: {asc\|desc} ( optional, default asc ) mode: {default\|key\|subkey} ( optional, default to value)	this will sort an array ( for mode key or default value ) or an object ( for mode subkey ) by the subkey values in the direction you define ( asc or desc )

Response ( BODY )

{
	"status": true,
	"message": "mossByte successfully manipulated",
	"data": {
		"instructions": [
			{
				"status": true,
				"function": "set",
				"key": "string_key"
			},
			{
				"status": true,
				"function": "append",
				"key": "string_key"
			},
			{
				"status": true,
				"function": "divide",
				"key": "number_key"
			},
			{
				"status": false,
				"function": "divide",
				"key": "number_key",
				"reason": "no defined value for divide function" // Note: that there was an error with modifying this key
			},
			{
				"status": true,
				"function": "append",
				"key": "string_key"
			},
			{
				"status": true,
				"function": "toggle",
				"key": "boolean_key"
			},
			{
				"status": true,
				"function": "days",
				"key": "datetime_key"
			},
			{
				"status": true,
				"function": "append",
				"key": "string_key"
			},
		]
	}
}

key	description
status	Indicates the overall requests success status as a boolean value.
message	Indicates any issues if the returned status is not true.
data.instructions	This will be the original list less the values and with a status boolean indicator of their success. Reason keys will exist when the status is not true.

API v1 documentation

base_url:

Request ( BODY )

Response ( BODY )

Response ( BODY )

Response ( BODY )

Request ( BODY )

Response ( BODY )

Response ( BODY )

Request ( BODY )

Functions

Response ( BODY )