HELP & Documents

[...]




Date: 2017.6.13        Author: Admin

Search index: (title and article description search)

No record was found!

MicroData API


MicroData API


MicroData is a small NoSQL API that offers fast read access to a key documents table.

Data storage is 5Mb, 5 Mb are enough to keep more than 20000 contacts basic info.

Offers CRUD stadard operations using RESTful API's. Read speed is limited to the number of our servers at the moment, write speed is limited to a maximum 15/second but no less that 5/second. Speed is per table.

MicroData is controlled using the webdo.com control panel  using the Database panel.

One tables collection is stored under an APK key.

MicroData are recommended for configuration files, lists, and data entries that are flushed from time to time to not exceed the 5Mb limitation.

Guest access - allows access without authorization
Authoriztion access - gives access to authorized users
Set Auth access rights to READ in order to have read access from authorized users, the account owner will always have full access.

All origin, set CORS to allow access to all origins, or set a list of allowed origins like https://dbv.webcentral.eu that is the table viewer. 

Alert email will send an email wherever an record is added.





The API

See Authorization API here.

NoSQL data storage

Microdata:
- fast read concurent access;
- low write concurency (up to 5/second);
- 5Mb/table (up to 30,000 records);
- CRUD RESTful API;
- ACID (per table);
- no declared structure (primary key is ID if not declared);

Standard:
- reserved* concurent access;
- reserved* write concurency;
- CRUD RESTful API;
- no declared structure (primary key is ID if not declared);
*reserved = reserved access rate read/write, price is per table/units/month

One aplication can mix database servers (SQL,NoSQL).

RESTful API, CRUD (Create, Read, Update, Delete)

Server address:q-ube.com
Protocol:HTTPS
Port:3800
API:wdb

Standard CRUD interface.

ActionHTTP method
CreatePOST
READGET
UPDATEPUT
DeleteDELETE

HTTP request HEADERS:
- apikey (required)
- authorization (required depending on table access rights settings /JWT Bearer authorization token)

CREATE:
Sample HTTP request parameters:

			Url: https://q-ube.com:3800/wdb/contacts
			Method: POST
			Headers:apikey: your api key
			Data: {"records":[{record object},{record object},...]}
			
			Response is a JSON object.

READ:
Sample HTTP request parameters:

			Url:     https://q-ube.com:3800/wdb/contacts
			Method:  GET
			Headers: apikey: your api key
		             Authorization: Bearer auth_key
			
			Response is a JSON object.
			Add query parameters to filter the result (default all records are returned).

UPDATE:
Sample HTTP request parameters:

			Url:     https://q-ube.com:3800/wdb/contacts
			Method:  PUT
			Headers: apikey: your api key
			         Authorization: Bearer auth_key
			Data: {"records":[{record object},{record object},...]}
					(record id is required)
					
			Response is a JSON object.
			

DELETE:
Sample HTTP request parameters:

			Url:     https://q-ube.com:3800/wdb/contacts
			Method:  DELETE
			Headers: apikey: your api key
			         Authorization: Bearer auth_key
			Data: {"records":[{id object},{id object},...]}
			
			Response is a JSON object.
			Delete is final / no recovery method.
			

Exposed as asynchronous functions (callback):

https://cdn.webcentral.eu/webapps/microdata.js


Sample:
AngularJS


sendrecords($http,false,apikey,"contacts",[record],function(err,data){ ... code ...});


Add one contact record from a simple contact form (no authorization / origin may be set on table properties).















Loading data

Loading WordBricks ...

| 1.1.1. Welcome| 1.1.2. Register a new account| 1.1.3. Start| 1.1.4. Technical support| 1.2.1. New website| 1.2.2. New page| 1.2.3. Sections / Page BLOCKS| 1.2.4. Settings| 1.2.5. Save / Backup / Restore| 1.2.6. Background| 1.2.7. My pages| 1.2.8. Page settings| 1.2.9. Website header| 1.2.10. Website menu| 1.2.11. Publish| 1.2.12. Compatibility| 1.2.13. Specials blocks| 1.2.14. DATABLOCKS| 1.2.15. Contacts Form| 1.2.16. Numbers Shuffle - Game| 1.2.17. ChatBox| 2.1.1. WEB hosting| 2.2.1. Hosting plans| 2.3.1. Domain Names| 2.3.2. Register a new domain name| 2.3.3. Domain name management| 2.3.4. Add a SSL certificate| 2.3.5. Create a SSL certificate| 2.3.6. Domain Name Redirects| 2.4.1. SEO informations| 3.1.1. DRIVE| 3.2.1. Files storage| 3.2.2. API drive access| 3.2.3. Safe share files| 3.3.1. WebDO IDE| 4.1.1. Email| 4.1.2. Email Services Names| 5.1.1. Databases| 5.1.2. API key| 5.2.1. Micro data| 5.3.1. Datasets (test fake data)| 6.1.1. We use SOA| 6.2.1. Authorization| 6.2.2. File access| 6.2.3. SendMail| 6.2.4. QR Code| 6.2.5. Document storage API| 6.2.6. MicroData API| 6.2.7. SQL API| 6.2.8. IP API| 6.2.9. DRIVE API| 6.2.10. Link Redirects API| 7.1.2. WebDo CLOUD| 7.1.3. Services Domains| 8.1.1. Payment| 8.1.2. European VAT| 8.2.1. Privacy policies| 8.2.2. Refund policies| 8.2.3. Change web hosting plan| 8.2.4. Minimum order value| 9.1.1. Terms and conditions| 10.1.2. About us| 10.1.2. | 11.1.3. Newsletter Application| 11.2.1. Dashboard| 11.2.2. Subscribers| 11.2.3. Campains| 11.2.4. Email Builder| 11.2.5. Forms| 11.2.6. Forms Builder| 11.2.7. Subscribers Management| 11.2.8. Integrate a custom subscription form using webdo website builder| 12.1.1. Survey Application| 12.2.1. Dashboard| 12.2.2. Add/Edit survey| 12.2.3. Settings| 12.2.4. Campaigns| 12.2.5. Reports| 12.2.6. Survey preview| 12.2.7. Page jumps| 12.2.8. Question types| 13.1.1. E-Detailing Application| 13.2.1. Dashboard| 13.2.2. Presentations| 13.2.3. Campaigns| 13.2.4. Reports| 13.2.5. Templates|