Basics

This guide will help you get started with using the Varvault API to store and manage variables for your user interface applications and embedded board devices such as NodeMCU, Raspberry pi or Arduino.

Quick Guide

1. Register: (See the API Method User Registration)

   Provide a username and a password. These credentials will be used to add future variables to your account and to delete them.

2. Generate Token: (See the API Method Token Generation)

   Use your registered username and password to generate a token that will expire in 30 days. The token will be used to authenticate your requests to update your variable values.

3. Add a variable: (See the API Method Adding a variable)

   Use your registered username and password to add a variable name (i.e. Temperature) and its any first value. You can specify its type (numeric, boolean, or text) and the unit (i.e. Celcius, Pa, °F)

4. Update the variable: (See the API Method Updating a variable)

   Use your generated token to update the variable you just created. This endpoint is usually the one that you will put in your embedded board devices. (See our Tutorials)

5. Read the variable: (See the API Method Reading a variable)

   Read your variables. This would be essential if you have created an application that needs the value of your variable (i.e. Android App)

All VarVault API's Endpoints:

1. User Management

   • `/user/register` : Register a new user account.
   • `/user/change-username` : Change the username an existing user.
   • `/user/change-password` : Change the password an existing user.
   • `/user/gen-token` : Generate an authentication token for an existing user.
   • `/user/renew-token` : Renews the expiration of the authentication token.

2. Variable Management

   • `/var/add` : Add a new variable for the authenticated user.
   • `/var/add-viatoken` : Add a new variable using a generated token.
   • `/var/update` : Update an existing for the authenticated user.
   • `/var/update-viatoken` : Update an existing variable using a generated token.
   • `/var/delete` : Delete a variable for the authenticated user.
   • `/var/delete-viatoken` : Delete a variable using a generated token.
   • `/var/read` : Read the value of a specific variable for the authenticated user.
   • `/var/read-viatoken` : Read the value of a specific variable using a generated token.
   • `/var/read-all/<format1> or <format2>` : Read all variables associated with the authenticated user in a specified format.
   • `/var/read-all-viatoken/<format1> or <format2>` : Read all variables associated a generated token in a specified format.