Build your HTTP connector schema

Kathyana Queeman
  • Updated

Download the Postman schemas

This article covers the schemas used to build your own HTTP connector using the provided Postman collection. There are three schemas which must be used in the presented order. Learn more about the concepts behind creating an HTTP connector.

Warning

You cannot create a new resource or endpoint without a connector! You must create the connector, then the resource, and finally the endpoints. After, you can add as many resources or endpoints as you want.

httpconnectors

This schema allows you to create an HTTP connector.

Request body

The request body is as follows:

Name (required): Name of the application.

Published: This field must always remain false.

baseURIs (required): The application's base URL. It's an array object field that can hold multiple base URIs, but by default, it will show the very first URI from the array. It can be mentioned globally, locally, and inside the version array object.

helpURL: Add a link to your own connection guide.

Versioning: Defines how the versioning is done for this application.

versioning subSchema

Versioning can be mentioned in 3 ways:

  • URI level

  • Query Param level

  • Header level

{
       location: [uri, query_parameter, header]
       headerName: ''
       queryParameterName: ''
}

Versions (required): An array of different versions applicable for the connector/api. The version is explained in the collapsible section below.

versions subSchema

baseURIs: The application's base URL. It's an array object field that can hold multiple base URIs, but by default, it will show the very first URI from the array. It can be mentioned globally and locally, inside the version array object, too, as per the requirements.

relativeURI: Relative to your connector’s version.

supportedBy: Configurations and settings applicable for this connector.

supportedBy subSchema

For Export and Import subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

      • Method:

      • linkHeaderRelation:

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

  • fieldsUserMustSet (Required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Connection subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • fieldMap

        • Name

          • Id (Required)

          • Name (Required)

          • Type (Required)

          • Label

          • Required

          • helpText

          • validWhen

            • matchesRegex

              • Pattern

              • Message

        • Layout

          • fields

  • fieldsUserMustSet (required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • Name

      • Scopes

apis: If the connector has multiple independent APIs then a list of all APIs should be defined. This should be an array.  For example, Shopify has Partner APIs and Payment APIs. Both are mutually exclusive APIs designed for different purposes.

APIs subSchema

name (required): API name.

published: This field must always remain false.

versioning: versioningSubSchema

versioning subSchema

Versioning can be mentioned in 3 ways:

  • URI level

  • Query Param level

  • Header level

{
       location: [uri, query_parameter, header]
       headerName: ''
       queryParameterName: ''
}

Versions (required): versionSubSchema

versions subSchema

baseURIs: The application's base URL. It's an array object field that can hold multiple base URIs, but by default, it will show the very first URI from the array. It can be mentioned globally and locally, inside the version array object, too, as per the requirements.

relativeURI: Relative to your connector’s version.

supportedBy: Configurations and settings applicable for this connector.

supportedBy subSchema

For Export and Import subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

      • Method:

      • linkHeaderRelation:

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

  • fieldsUserMustSet (Required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Connection subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • fieldMap

        • Name

          • Id (Required)

          • Name (Required)

          • Type (Required)

          • Label

          • Required

          • helpText

          • validWhen

            • matchesRegex

              • Pattern

              • Message

        • Layout

          • fields

  • fieldsUserMustSet (required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • Name

      • Scopes

supportedBy (required):  Configurations and settings applicable for this connector.

supportedBy subSchema

For Export and Import subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

      • Method:

      • linkHeaderRelation:

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

  • fieldsUserMustSet (Required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Connection subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • fieldMap

        • Name

          • Id (Required)

          • Name (Required)

          • Type (Required)

          • Label

          • Required

          • helpText

          • validWhen

            • matchesRegex

              • Pattern

              • Message

        • Layout

          • fields

  • fieldsUserMustSet (required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • Name

      • Scopes

httpconnectorresources

This schema allows you to create an HTTP resource.

Resource body

_id (required): A unique identifier for each resource, later used to render the endpoints under respective resources.

name (name): Name of the resource.

published: This field must always remain false.

_versionId (required): An array field that will provide the version IDs generated after making the httpconnectors API call. Based on the provided version IDs and connector ID, this resource will render for a particular connector.

_httpConnectorId (required): Unique connector ID from the httpconnectors API response after making the API call.

Note

The  _versionId and _httpConnectorId are only available after creating the connector using the httpconnectors API endpoint. You’ll need to copy these values from the httpconnectors API response body after creating the connector.

resourceFields: This is an array object field, which will be used to define the structure of the request body for a resource as per the API Doc or to produce the mapping dropdown.

  • id: unique identifier of the resource field.

  • dataType:  Defines the datatype (Object, ArrayObject, String, etc.).

  • resourceFields: Supported resource fields.

    • id: unique identifier of the resource field.

    • dataType:  Defines the datatype (Object, ArrayObject, String, etc.).

supportedBy: Configurations and settings applicable for this connector.

supportedBy subSchema

For Export and Import subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

      • Method:

      • linkHeaderRelation:

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

  • fieldsUserMustSet (Required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Connection subschemas:

  • preConfiguredFields (required): Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • fieldMap

        • Name

          • Id (Required)

          • Name (Required)

          • Type (Required)

          • Label

          • Required

          • helpText

          • validWhen

            • matchesRegex

              • Pattern

              • Message

        • Layout

          • fields

  • fieldsUserMustSet (required): Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • Name

      • Scopes

httpconnectorendpoints

This schema allows you to create an HTTP endpoint.

Request body

name (required): Endpoint name.

description: Description of the endpoint.

published: This field must always remain false.

_httpConnectorResourceId: Unique resource ID from the httpconnectorresources API response after making the API call.

Note

The  _httpConnectorId is only available after creating the connector using the httpconnectors API endpoint. Similarly, the  _httpConnectorResourceId is only available after creating the resource using the httpconnectorresources API endpoint. You’ll need to copy these values from the API response bodies after creating them.

method (required): Method of the endpoint.

relativeURI (required): Relative URL of the endpoint.

pathParameters subSchema

queryParameters: All query parameters can be defined under this array object.

  • name (required): Name of the query parameter.

  • description (required): Description of the query parameter.

  • required (required): A boolean field that defines if the resource is required.

supportedBy subSchema

For Export subschemas:

  • preConfiguredFields: Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • resourcePath

  • fieldsToUnset

  • lookupToIdentifyExisting

  • fieldsUserMustSet: Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Import subschemas:

  • preConfiguredFields: Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

      • Name

      • Value

  • fieldsToUnset

  • lookupToIdentifyExisting

  • pathParameterToIdentifyExisting

  • fieldsUserMustSet: Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

For Connection subschemas:

  • preConfiguredFields: Requirements that remain the same regardless of who created the connection or when it was created. For example, the application’s Base URI (if fixed) or the authentication type. Learn more about preConfiguredFields. For each preConfiguredFields, there will be two fields:

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

  • fieldsUserMustSet: Fields under this array object are mandatory, and users must provide input. Learn more about fieldsUserMustSet.

    • path:  Each path will be used to provide a location that we want to pre-configure.

    • values: Each value will contain one or multiple details that you want to predefine on a specific location or a particular field. The value can be assigned to any particular location or field by providing a path.

Related articles

Comments

0 comments

Article is closed for comments.