Skip to content

jetstream-gitbook/jetstream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

JetStream

Welcome to the JetStream API

The Data APIThe Data API allows other systems to search for, read, create, modify and delete data in your application’s database via a RESTful interface.broken-reference
The Workflow APIThe Workflow API allows external applications to execute workflows in your JetStream app via a RESTful interface.broken-reference

{% file src=".gitbook/assets/folder.json" %}

{% swagger src=".gitbook/assets/link-example.json" path="/2.0/users/{username}" method="get" %} link-example.json {% endswagger %}

{% swagger src=".gitbook/assets/folder.json" path="/2.0/users/{username}" method="get" %} folder.json {% endswagger %}

### The API Connector

We use the API Connector to make outgoing connections to external applications and use it as a data source or trigger actions.

https://www.google.com

Want to jump right in?

Feeling like an eager beaver? Jump in to the quick start guide and start building:

https://www.gitbook.io

Manual references

Our manual includes extended information about our API’s features and how to use them. Got questions? Drop Maria Herschel a line on Slack ✨

https://www.gitbook.io

Introduction to APIs

This article series takes an in-depth look at what exactly an API is and how you can both set up an API in JetStream and connect to external APIs in different ways.

Article: Introduction to APIs
Video: Introduction to APIs
Article: What is a RESTful API?

Authenticating with the JetStream API

Authentication is the process of identifying who the client is in order to determine what they have access to.

Article series: The JetStream API and authentication


Authentication types
The JetStream API lets clients authenticate in different ways:

Article: Accessing the JetStream API without authentication
Article: Accessing the JetStream API authenticated as a User
Article: Accessing the JetStream API authenticated as an admin\

How to set up authentication in the external system
The JetStream uses the bearer token method to authenticate clients.

Article: How to set up authentication in an external app

The Data API

The Data API lets you set up an API in your JetStream application that accepts incoming requests to search for, read, create, edit and delete entries in your database.

Article series: The Data API

The Workflow API

The Data API lets you set up an API in your JetStream application that accepts incoming requests to trigger workflows.

Article series: The Workflow API

The API Connector

The API Connector lets you connect to external RESTful APIs to trigger workflows or to use as a data source.

Article series: The API Connector

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published