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. Reference: Schema Designer
Request Body	Create New Field	It can create fields using the create field Model. Reference: Schema Designer

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. Reference: Schema Designer
Response Body	Create New Field	It can create fields using the create field Model. Reference: Schema Designer

Schema Designer

Generate Schema

A "generate schema" typically refers to the process of defining or creating a structured format that outlines how data is organized, validated, and transmitted, especially in contexts like APIs or databases.
In noKodr, users can define fields using JSON format.

Button	Description
Cancel	It allows the user to exit the "Generate Schema" process. If any changes were made in the modal, they will be discarded, and no new schema will be generated.
Recreate	It is used to reset the schema creation form within the modal. All fields will be cleared or set to their default values, enabling the user to begin the process of defining a new schema from scratch.
Merge	It allows the user to merge the newly generated schema with an existing schema. This is useful when the user wants to integrate new schema elements into a pre-existing schema without completely overwriting it. Reference: Schema

Create New Field

In cases where a user does not have data in XML format but has it in JSON format, the application allows the user to create a schema by adding new fields directly.
This feature is particularly useful for users who need to generate or modify schemas based on their JSON data structure.

Field Config	Description
Name	The identifier for the field within the schema. This is the name that will be used to reference the field in the data structure.
Type	It specifies the data type of the field. Note: By default, field type is text. Reference: Field Type
Required	It indicates whether the field is mandatory.
Minimum Length	It defines the minimum number of characters or elements that the field must contain.
Maximum Length	It defines the maximum number of characters or elements that the field must contain.
Pattern	It is a regular expression that the field’s value must match. This is typically used for validating formats like email addresses, phone numbers, etc.
Help Text	It provides additional information or guidance on what the field represents and how it should be used. This is often displayed in the UI to assist users.
Default Value	It is a predefined value that the field will take if no other value is provided. This helps in setting initial values.

Schema

Field Type

Field Type	Description
Array	It represents a collection of items, where each item can be of the same type or a specified set of types. Arrays are useful for storing lists or multiple values under a single field. For example, A list of user roles in a system: `["admin", "editor", "viewer"]`
Checkbox	It represents a boolean value, typically used in forms to indicate a true/false or yes/no option. This field type is ideal for settings or preferences that can be toggled on or off. For example, A `Subscribe to newsletter` option
Date	It stores a date value without time information. This type is used when only the date is relevant, such as a birthdate or a specific event date. For example, `"2024-08-26"`
Date and Time	It stores both date and time information. This is used when the exact moment of an event is important, such as timestamps for record creation or updates. For example, `"2024-08-26T14:30:00Z"`
Double	It represents a floating-point number, suitable for storing decimal values or precise measurements. This type is ideal for fields that require numeric data with fractions. For example, `1234.56`
Integer	It represents a whole number without any decimal points. This type is used for counting or indexing, such as user IDs, quantity fields, or age. For example, `42`
Object	It represents a structured data type that can contain multiple named properties, each with its own type. Objects are used for more complex data structures, such as nested entities. For example,
Text	It stores plain text, which can be a short string or a longer block of text. This field type is used for any data that needs to be expressed in words, such as names, descriptions, or comments. For example, `"This is a sample text field."`

API Type Model