frends Docs - Integration Platform Documentation

API Development

The Academy course on API Development

Welcome to API Development

First Introduction - Frends APIs

Introduction to What is needed for creating an API

Introduction to Process of creating an API and How to create an API Specification

Example on How to create or link a Process to an API

Example on How to deploy an API

Introduction to How to configure an authentication method for an API

Introduction to How to test an API and API - Key concepts

Introduction to Understanding the Frends API List View

API - Where to get help?

Building your first API - Concrete Example

Introduction to Building your first API and API definition

Example on Building your first API definition

Introduction to creating Linked Processes

Example on Creating a new Linked Process

Introduction to Deploying your API

Building Frends APIs - Testing your first API

Example on How to find and use Swagger UI

Building Frends APIs - Open API Specification and Authorization

Introduction to OpenAPI Specification

Introduction to OpenAPI 2.0 and OpenAPI 3.0

Introduction to API definition header section

Introduction to API Paths section

Introduction to API authentication

Introduction to API Authentication with Frends

Building Frends APIs - Linking APIs to Processes

Introduction to API Trigger

Introduction to API Trigger settings

Introduction to Intermediate Return

Example on Intermediate Return

Example on Intermediate Return Settings

Introduction to HTTP Response

Example on HTTP Binary Response

Building Frends APIs - API Keys

Introduction to API Keys

Introduction to Defining the use of API Key on OpenAPI Specification

Example on Typical API use case scenario

Example on Creating API Keys

Introduction to Passing an API Key to Frends API from a client

Introduction to Rulesets

Example on Basic Ruleset scenario

Example on Ruleset with different access for different API consumer types

Example on Ruleset for full access to Campaign API

Building Frends APIs - OAuth

Introduction to OAuth 2.0

Introduction to Defining the use of OAuth 2.0 in OpenAPI Specification

Introduction to Configuring OAuth Application

Introduction to API Access Policies

Advanced API Development - How APIs work

Introduction to How Frends APIs work

Introduction to Using Subprocesses in APIs

Advanced API Development - Writing API Specification

Introduction to Writing API Specification

Introduction to API Specification Naming and versioning

Introduction to API Specification How to use Swagger Editor

Advanced API Development - Implementing Endpoints

Introduction to Implementing Endpoints

Example on Building a Linked Process

Example on How to test and debug a Linked Process

Advanced API Development - Deploying APIs and Updating API Endpoints

Introduction to Deploying APIs and API Version Control

Example on Deploying the current Development version of an API

Example on Deploying a previously Published API version

Introduction to updating API operations

Example on Updating API Triggers of the existing Linked Processes

Example on Unlinking removed API Operations

Advanced API Development - Examples

How to use OAuth 2.0 Implicit flow in APIs published in Frends

How to use OAuth 2.0 Client Credentials flow in APIs published in Frends

How to use OAuth 2.0 Authorization Code in APIs published in Frends

How to use OAuth 2.0 Authorization Code flow with PKCE in APIs published in Frends

Introduction to HTTP Proxy and Wildcards in Frends

Example on Building HTTP request authentication in Processes