Tutorials

Revision as of 17:15, 2 February 2016

This section consists of short, example-based tutorials for the most common DreamFactory use cases.

Topics in this section include:

1. 1. Setting up API Services

• Database and server side scripting support by host type
• Connecting to SQL
• Connecting to NoSQL
• Connecting to File Storage
• Connecting to Email Services
• Connecting to Push Notification Services
• Connecting to Remote Web Services

1. 1. Using the REST API

1. 1. 1. Upgrading your app

• Upgrading your app from 1.x

1. 1. 1. Users

• Creating users
• Logging in
• Logging out
• Open registration
• Confirming new users
• Setting up guest access
• Basic auth
• Access using API key
• Access using JWT
• Access using JWT and API key
• Refreshing a JWT
• Forever sessions
• Using forever sessions

1. 1. 1. SQL and NoSQL Data

• Querying records with logical filters
• Querying records with an ID list
• Querying for a single record by ID
• Querying records in a date range
• Specifying fields
• Sorting records
• Paginating records with limits and offsets
• Posting records
• Updating records
• Deleting records

1. 1. 1. SQL-Specific Data

• Querying multiple tables with joins
• Posting data to multiple tables with joins
• Querying SQL views
• Calling stored procedures
• Calling SQL functions

1. 1. 1. Files

• Uploading file
• Downloading file
• Deleting file
• Adding a text file

1. 1. 1. Email

• Sending email

1. 1. 1. Push Notifications

• Sending push notifications

1. 1. 1. Remote Web Services

• Edmunds API
• Rotten Tomatoes API

1. 1. Scripting

1. 1. 1. V8 Javascript

• Field validation example
• Push notification workflow rule example
• Custom scripting service example

1. 1. 1. Node.js

Coming soon!

1. 1. 1. PHP

• Field validation example
• Push notification workflow rule example
• Custom scripting service example

1. 1. User Management & Security Settings

1. 1. 1. Role-Based Access Control

• Setting up user roles
• Setting up application default role
• Accessing SQL tables
• Accessing NoSQL collections
• Record-level access control with server-side filters
• Accessing documents
• Accessing email services
• Accessing push notifications
• Accessing remote web services
• Enabling script access
• Using role lookup keys

1. 1. 1. Single Sign On

• Using LDAP
• Using Active Directory
• Using OAuth

1. 1. 1. Active Directory

• Importing Groups as Roles
• Mapping Roles to AD Groups
• Retrieving AD Groups
• Retrieving AD Users
• Retrieving AD Computers

1. 1. Configuration Settings

• Clearing the System cache
• Enabling CORS Access
• Setting up email templates
• Setting up lookup keys