Signup and createa new application. This is one time step. The application name must be unique and will act as app key.
Subscriptions: FREE, BASIC, PROFESSIONAL, ENTERPRISE.
Every user needs to login with their username/password to generate Authorization token. This token will be used for all future API calls on users behalf. If it expires, then user will have to login again.
https://v1.stormapi.com/users/login
The API client should set up Authorization header received from login step.
You can create total numbers of entities based on your subscription plan. The name must be unique.
https://v1.stormapi.com/entities/create
Properties contain list of fields. Each field has name, type, length(applicable to string, decimal, int), precision(applicable to decimal) and validations.
User with admin role has access to all entities and can perform all operations.
type: string, text, date, datetime, int, decimal.
validations rules are as follow:
| Rule Name | What is does |
|---|---|
| required | |
| eg {“required”:true} | This field is required |
| decimal | |
| eg {“decimal”:true} | This field value must be a decimal |
| integer | |
| eg {“integer”:true} | This field value must be an integer |
| number | |
| eg {“number”:true} | This field value must be a number |
| date | |
| eg {“date”:true} | This field value must be a valid (2020-01-25) |
| datetime | |
| eg {“datetime”:true} | This field value must be a valid (2020-01-25 22:12:05) |
| json | |
| eg {“json”:true} | This field value must be a valid JSON |
| integer | |
| eg {“integer”:true} | This field value must be an integer |
| emailAddress | |
| eg {“emailAddress”:true} | This field value must be a valid email address |
| ipAddress | |
| eg {“ipAddress”:true} | This field value must be a valid IP address |
| macAddress | |
| eg {“macAddress”:true} | This field value must be a valid MAC address |
| greatherThen | |
| eg {“greatherThen”:100} | This field value must be greater then 100 |
| lessThen | |
| eg {“lessThen”:200} | This field value must be less then 200 |
| greaterThenEqual | |
| eg {“greaterThenEqual”:300} | This field value must be greater then equal to 300 |
| lessThenEqual | |
| eg {“lessThenEqual”:400} | This field value must be less then equal to 400 |
| in | |
| eg {in:[10, 20, 30, “text1”, “text2”] | This field value must be from given list |
| contains | |
| _eg {“contains”:“sample text”} _ | This field value must contain “sample text” |
| containsAll | |
| eg {“containsAll”:[“text1”, “text2”]} | This field value must contain all in list |
| containsAny | |
| eg {“containsAll”:[“text1”, “text2”]} | This field value must contain one of value for list |
| regex | |
| eg {“regex”:"/[a-zA-Z]/"} | This field value must match pattern |
| regexAll | |
| eg {“regexAll”:["/[A-Z]/","/[0-9]/"]} | This field value must match all rules |
| regexAny | |
| eg {“regexAny”:["/[A-Z]/","/[0-9]/"]} | This field value must match any one of rule |
| greatherThenDatetimeField | |
| eg {“greatherThenDatetimeField”: “fieldName”} | This field value must greater then fieldName value |
| lessThenDatetimeField | |
| eg {“lessThenDatetimeField”: “fieldName”} | This field value must less then field fieldName value |
| greaterThenEqualDatetimeField | |
| eg {“greaterThenEqualDatetimeField”: “fieldName”} | This field value must greater then equal field fieldName value |
| lessThenEqualDatetimeField | |
| eg {“lessThenEqualDatetimeField”: “fieldName”} | This field value must less then equal field fieldName value |
| greatherThenDatetime | |
| eg {“greatherThenDatetime”:“2020-01-24 13:23:15”} | This field value must greater then |
| lessThenDatetime | |
| eg {“lessThenDatetime”:“2020-01-24 13:23:15”} | This field value must less then |
| greaterThenEqualDatetime | |
| eg {“greaterThenEqualDatetime”:“2020-01-24 13:23:15”} | This field value must greater then or equal |
| lessThenEqualDatetime | |
| eg {“lessThenEqualDatetime”:“2020-01-24 13:23:15”} | This field value must less then or equal |
https://v1.stormapi.com/roles/create
Manage permissions to access entities by roles using “Privileges” entity.
https://v1.stormapi.com/priviledges/create
https://v1.stormapi.com/priviledges/create-all
https://v1.stormapi.com/priviledges/read-all
https://v1.stormapi.com/contacts/create
https://v1.stormapi.com/contacts/create-all
https://v1.stormapi.com/accounts/update
https://v1.stormapi.com/contacts/update-all
https://v1.stormapi.com/contacts/read/1
https://v1.stormapi.com/contacts/read-all
https://v1.stormapi.com/contacts/delete/1
https://v1.stormapi.com/users/create
Build Enterprise Grade Mobile Apps and Web Apps faster with secure and reliable BaaS services of StormAPI.
Copyright @ Storm API. All Rights Reserved