Overview

Before heading to this section, we need to have some basic understanding about API connections. Let us go through that first.

Pre-requisites

Auth Provider Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.sso_provider_sfdc.htm&type=5
Auth Provider Trailhead: https://trailhead.salesforce.com/content/learn/modules/identity_external/identity_external_social?trail_id=identity
Named Credentials Salesforce Docs: https://developer.salesforce.com/docs/platform/named-credentials/guide/get-started.html
Named Credentials Trailhead: https://trailhead.salesforce.com/content/learn/projects/quick-start-create-http-callouts-with-flow-builder/create-the-credentials
Connected App Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.connected_app_create.htm&type=5
Connected App Trailhead: https://trailhead.salesforce.com/content/learn/projects/build-a-connected-app-for-api-integration/create-a-connected-app

This will give an idea about Auth Provider and its configuration, Named Credentials and its configuration as well as Connected App for OAuth settings. Also, if you want to completely go through this you can refer:

Reference:

Named Creds Blog: Connecting with external application using Rest API
REST API Configuration: REST API Configuration - noKodr-For Salesforce

API Model

In this section, you can see various option while creation model for API types let’s understand each:

Details

Details Config	Description
Type	Specify the type of model, such as: API: For integrating with external applications via REST APIs. Record: For managing Salesforce object data.
Connection	Allows you to choose the desired REST connection to fetch records from.
Label	Assign a unique name to the model. Note: After choosing Connection, this field auto-populates, mirroring the connection label, which can be edited later.
Name	Provide unique API name for the model. Note: After choosing Connection, this field auto-populates, mirroring the connection name, which can be edited later.
Execute on Load	Enables records to be fetched automatically upon loading the component

Request

Request Config Group	Config Name	Description
Request Parameters	Method	Different HTTP methods such as GET, POST, PATCH, etc. are used to perform specific operations on resources. You can explore more about methods here.
	URL	Add the relevant URL that corresponds to the connection from which you wish to perform CRUD.
	Record Count	Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operation.
	Query Params	It is way to pass information to an API in a flexible and simple manner. They are added to the end of the API endpoint URL as a series of key-value pairs. It can be used for filtering, sorting, pagination, formatting or searching the data.
	Headers	It is used to provide additional information about the request, such as the format of the request body, the client's preferred language, authentication credentials, and more.
Request Body	Generate Schema	It can define fields using JSON format.
Request Body	Create New Field	It can create fields using the create field Model

Response

Response Config Group	Config Name	Description
Response Parameters	Status Code	It indicates whether a specific HTTP request has been successfully completed.
	New Button	It allows to specify new Status Code as per one's business need.
	Record Count	Set the record count to either Multirecord or Single, depending on whether you are dealing with multiple records or a single record in the data operation.
Response Body	Generate Schema	It can define fields using JSON format.
Response Body	Create New Field	It can create fields using the create field Model

API Type Model