Getting Started with Recordr

Last updated: December 26th, 2018

Getting Started

Getting started with Recordr is easy. There are no software packages to install, as everything is API-driven. The one thing that Recordr does require is a Padloq account. Padloq is our free OAuth login and application authorization app. We also built Padloq.

Get Padloq

Installation

Step One

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis.

Default code example:

bower install <package>

npm install <package>

Step Two

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

Un-ordered list example
  • Lorem ipsum dolor sit amet.
  • Aliquam tincidunt mauris.
  • Ultricies eget vel aliquam libero.
    • Turpis pulvinar
    • Feugiat scelerisque
    • Ut tincidunt
  • Pellentesque habitant morbi.
  • Praesent dapibus, neque id.
Ordered list example
  1. Lorem ipsum dolor sit amet.
  2. Aliquam tincidunt mauris.
  3. Ultricies eget vel aliquam libero.
    • Turpis pulvinar
    • Feugiat scelerisque
    • Ut tincidunt
  4. Pellentesque habitant morbi.
  5. Praesent dapibus, neque id.

Step Three

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis.

Using Recordr

Recordr provides a RESTful API to create, query, modify, and delete collections, records, and fields.

Useful Tip:

You can recordr to store any type text-based data you'd like.

Create Collection

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}
HEADERS: 
Content-Type: application/json
Authorization: Bearer {padloq_token}
BODY: 
{
	"field_1" : "value",
	"field_2" : "value2"
}
RESPONSE BODY: 
{
    "key": "value"
}

Update Collection

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}
HEADERS: 
Content-Type: application/json
Authorization: Bearer {padloq_token}
BODY: 
{
	"key" : "value",
	"field_1" : "AnotherValue",
}
RESPONSE BODY: 
{
    "key": "value"
}

Useful Tip:

Increasing or decreasing is a great way to easily change usage without querying and adding or subtracting.

Increase Datapoint/Counter

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}
HEADERS: 
Content-Type: application/json
Authorization: Bearer {padloq_token}
BODY: 
{
	"key" : "value",
	"counter_1" : "++(1)"
}
RESPONSE BODY: 
{
    "key": "value"
}

Useful Tip:

Recordr uses the GraphQL language structure for querying.

Query Collection

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}
HEADERS: 
Content-Type: text/plain
Authorization: Bearer {padloq_token}
BODY: 
{
	query {
		key
		field_1
	}
	query_counters {
		key
		counter_1
	}
}
With field filters: 
{
	query(key : "value") {
		key
		field_1
	}
	query_counters(key : "value") {
		key
		counter_1
	}
}
RESPONSE BODY: 
{
    "query": [
        {
            "key": "value",
            "field_1": "value"
        }
    ],
    "query_counters": [
        {
            "key": "value",
            "counter_1": 14
        }
    ]
}

Useful Tip:

Deleting a collection cannot be undone.

Delete Collection

API 
DELETE - http://api.recordr.podleo.com/recordr/{collection_name}
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
None - response codes only

Useful Tip:

Deleting a record cannot be undone.

Delete Collection Record

API 
DELETE - http://api.recordr.podleo.com/recordr/{collection_name}/{key}
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
None - response codes only

Useful Tip:

Deleting a collection cannot be undone.

Delete Collection Field

API 
DELETE - http://api.recordr.podleo.com/recordr/{collection_name}/fields/{field}
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
None - response codes only

List Collections

API 
GET - http://api.recordr.podleo.com/recordr
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
{
    "collections": [
        {
            "name": "demo",
            "scope": "admin"
        }
    ]
}

List Access Controls

API 
GET - http://api.recordr.podleo.com/recordr/{collection_name}/acl
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
{
    "entries": [
        {
            "subject": "padloq|root@padloq.io",
            "scope": "admin"
        }
    ]
}

Modify Access Controls

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}/acl
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
{
    "subject": "padloq|chris@padloq.io",
    "scope": { admin | write | read }
}
RESPONSE BODY: 
None - response codes only

Set Collection Callbacks HTTP

API 
POST - http://api.recordr.podleo.com/recordr/{collection_name}/callbacks/http
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
{
    "callbacks": [
        {
            "endpoint": "http://postb.in/3EcK9p87"
        }
    ]
}
RESPONSE BODY: 
None - response codes only

Useful Tip:

You can recordr to store any type text-based data you'd like. For examples, check out some samples here

Get Collection Callbacks HTTP

API 
GET - http://api.recordr.podleo.com/recordr/{collection_name}/callbacks/http
HEADERS: 
Authorization: Bearer {padloq_token}
BODY: 
None
RESPONSE BODY: 
{
    "callbacks": [
        {
            "endpoint": "http://postb.in/3EcK9p87"
        }
    ]
}

Callouts

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo.

Aenean imperdiet

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium <code> , Nemo enim ipsam voluptatem quia voluptas link example sit aspernatur aut odit aut fugit.

Morbi posuere

Nunc hendrerit odio quis dignissim efficitur. Proin ut finibus libero. Morbi posuere fringilla felis eget sagittis. Fusce sem orci, cursus in tortor link example tellus vel diam viverra elementum.

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Link example aenean commodo ligula eget dolor.

Interdum et malesuada

Morbi eget interdum sapien. Donec sed turpis sed nulla lacinia accumsan vitae ut tellus. Aenean vestibulum Link example maximus ipsum vel dignissim. Morbi ornare elit sit amet massa feugiat, viverra dictum ipsum pellentesque.

FAQ

How does Recordr work?

Recordr works as a sort-of database-as-a-service, in that you don't need to setup, create, or host your own database(s) to operate. You just connect via RESTful API and you're off. See the documentation above for specific examples.

Buttons

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi nec imperdiet turpis. Curabitur aliquet pulvinar ultrices. Etiam at posuere leo. Proin ultrices ex et dapibus feugiat link example aenean purus leo, faucibus at elit vel, aliquet scelerisque dui. Etiam quis elit euismod, imperdiet augue sit amet, imperdiet odio. Aenean sem erat, hendrerit eu gravida id, dignissim ut ante. Nam consequat porttitor libero euismod congue.

Basic Buttons
CTA Buttons

Help

If you're having trouble getting started, or have general questions, etc., please feel free to email help@recordr.io.

Useful Tip:

If you're having trouble with Padloq, please email help@padloq.io.

Icons

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi nec imperdiet turpis. Curabitur aliquet pulvinar ultrices. Etiam at posuere leo. Proin ultrices ex et dapibus feugiat link example aenean purus leo, faucibus at elit vel, aliquet scelerisque dui. Etiam quis elit euismod, imperdiet augue sit amet, imperdiet odio. Aenean sem erat, hendrerit eu gravida id, dignissim ut ante. Nam consequat porttitor libero euismod congue.

Elegant Icon Font
elegant icons
FontAwesome Icon Font
fontawesome

Are you an ambitious and entrepreneurial developer?

Instance Theme

Instance - Bootstrap 4 Portfolio Theme for Aspiring Developers

Check out Instance - a Bootstrap personal portfolio theme I created for developers. The UX design is focused on selling a developer’s skills and experience to potential employers or clients, and has all the winning ingredients to get you hired. It’s not only a HTML site template but also a marketing framework for you to build an impressive online presence with a high conversion rate.

[Tip for developers]: If your project is Open Source, you can use this area to promote your other projects or hold third party adverts like Bootstrap and FontAwesome do!

View Demo
Xiaoying Riley