Blank Slate API Overview

Date: 4/13/2010

Blank Slate provides the core application services you need to build and
manage all kinds of apps.

Data APIs – Used to store, manipulate and search structured data. In

Blank Slate, developers work with content rather than data structures,
eliminating the need to create and maintain underlining schemas.
Data structures in Blank Slate automatically adapt to inputs, so adding
or removing data elements is automatic as usage evolves.

User Management APIs – Used to manage user accounts, including

username/password authentication, user profiles and access right to
content. Developers can track any number of attributes for a user
(email, address, phone, etc…) and integrate Data APIs to manage
record level authorization.
 Blank Slate API Overview
Date: 4/13/2010

Commerce APIs – Used to accept online payments securely,

including one time credit card transactions, recurring payments and
refunds. Payment transactions are logged and can be searched for
auditing , eliminating overhead of transaction management. Currently
supports PayPal.

File APIs – Used to store unstructured data (files) to remote storage.

Currently supports Amazon S3.

Messaging APIs – Used to send authenticated email messages

without the need to set up a SMTP server. Messages are logged and
can be searched for auditing. Currently supports AuthSMTP.
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Data APIs Data Persistence Data Search

APIs APIs

Update Delete Delete View

Create Update Search
Create (U) Records Record Records Record
JSONP (U) (U) (U)
(U) (U) (U) (U)

RSS Archive Spreadsheet Upload Search

Form Submit (U) Advanced (U)
(U) (U)

User Management APIs

User
Management

Register Validate Email Authenticate Update User Reset Search User

User (R) (R) (R) Profile (R) Password (R) (R)
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Commerce APIs Payment

APIs

Set Recurring Direct to PayPal Refund Payment Cancel Recurring

Pay by Credit (R)
Payment (R) Express Pay (R) (R) Payment (R)

File APIs Messaging APIs

File APIs Messaging
APIs

Upload File Remove File Send Email

(R) (R) (R)

Report APIs
Report APIs

Get Application Get User Get API Usage Get Data Get Advanced
Usage (R) Report (R) (R) Usage(R) Analyics (R)
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Data APIs
Data
Persistence
APIs
Create an entity and insert a record by submitting an HTML form with any number
Create (U)
of input fields, the data structure will automatically be created and updated
according to inputs.
Create JSONP Create an entity and insert a record by making a cross domain AJAX Call with any
(U)
number of inputs. Intended for use by client side JavaScript to store information
remotely.
Update Update a record by making a REST style API call using the programming
Record(U) language of your choice.

Update Update a set of record using specified search criteria by making a REST style API
Records (U) call using the programming language of your choice.

Delete Record Delete a record by making a REST style API call using the programming language
(U)
of your choice.
Delete Deletes a set of record specified by search criteria by making a REST style API call
Records (U)
using the programming language of your choice.
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Data
Persistence
APIs

Form Submit Works the same way as the create API but allow for specification of form
(U)
parameters such as a redirect URL, email notification on submit.

RSS Archive Allows user to specify one or more RSS feeds, this API will automatically detect the
(U)
RSS publish frequency and archive the RSS feed.

Spreadsheet Allows uploading of tabular data in spreadsheet formats and creates the data
Upload (U) structure to store the tabular data.

Data Query
APIs

Search (U) Find a set of records by using a REST style call with any number of query
parameters. You can specify sorting and pagination. Simple Query String style
search method.
Search Find a set of records by using a REST style call with any combination of
Advanced (U)
parameters and operators (AND, OR, LIKE, etc…) . Most queries traditionally
supported by SQL can be constructed using XML as input to this API.

Get Record (U) Get one record by a unique record key to get all the details of a record.
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

User Management APIs

User Management

Create User Create a user securely through SSL with a unique user name and password with
(R) any number of additional inputs (email, address, phone, etc…). Through a form
submit or an API call.

Validate Email Validate user’s email address by sending a user an email with a secret link. The
(R) user must click on this to validate and activate his or her account.

Authenticate Authenticate the user name and password using a SSL API call.
(R)

Update User Update the user’s profile information such as password, email, address, phone,
(R)
etc…

Reset Reset the user’s password by sending the user an email to a link to re-enter his or
Password (R)
her password.

Search User Find users by searching any field of his or her profile information (user name,
(R)
address, email, etc…)
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Commerce
APIs Commerce APIs

Pay by Credit (R) Accept credit card payment through SSL with by calling an API with required
credit card information. Transactions processed through this API will
automatically be logged and stored for auditing and payment management.

Set Recurring Create recurring payment through SSL with by calling an API with required credit
Payment (R) card information. . Transactions processed through this API will automatically be
logged and stored for auditing and payment management.

PayPal Express For PayPal users, set up an Express Pay payment by directing user to PayPal
Pay (R)
and setting return URL. Transactions processed through this API will
automatically be logged and stored for auditing and payment management.
Refund Payment Refund a payment through SSL by supplying the appropriate prior transaction
(R)
information. Transactions processed through this API will automatically be
logged and stored for auditing and payment management.
Cancel Recurring Stop a recurring payment through SSL by supplying the appropriate prior
Payment (R)
transaction information. Transactions processed through this API will
automatically be logged and stored for auditing and payment management.
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

File APIs File APIs

Upload File (R) Upload a file or image to Cloud storage (Ex. Providing AWS S3 keys and upload
files using a web form). File can be associated with a data record to store many
meta data.
Remove File (R) Delete a file and associated meta data.

Messaging APIs
Messaging APIs

Send Email (R) Send an Authenticated SMTP email by providing to “To” email address, a subject
and the message without setting up SMTP server. Messages are logged and
stored for auditing.
 Blank Slate APIs
U Unrestricted – May be accessed without an API Key if public access is granted the application owner
R Restricted – Must be accessed using an API Key

Report APIs Report APIs

Get Application Get information about your applications such as who’s using it, how much and
Usage (R) how often, etc…

Get User Report Get information about users, what they’re doing, how they’re using your
(R)
applications.

Get API Usage (R) Get metrics around the APIs you’re using.

Get Data Usage(R) Get information about the data your applications are storing, number of records,
files storage, etc…

Get Advanced Gain insight about how to optimize your applications, expand your user base,
Analytics (R)
etc…