Build an HTTP connector using Postman

Kathyana Queeman
  • Updated

Download the Postman schemas

You can now build an HTTP connector using the available Postman collection schemas. This article is not about connecting to an HTTP connector or using a connection API endpoint to create, update, or delete an existing connection. This article and the accompanying Postman collection schemas will allow you to build an HTTP connector you can then use to create a connection to a third-party application.

To build your connector, download the Postman file, configure the schemas, and post them to the following APIs:

OR for EU:

Warning

  • You must create your connector in the following order:

    • Connector

    • Resource

    • Endpoint

  • You can only create one connector, resource, and/or endpoint at a time. For example, if you want to create 3 resources with 5 endpoints each, you need to create each individual resource and endpoint separately. Do not attempt to create multiple resources or endpoints in one API call.

You may want to learn more about the HTTP connector schemas before creating your connector.

Connector

Learn more about connectors.

Create a connector

  1. Download the Postman collection and open the httpconnectors schema.

  2. Create the connector using the schema.

    1. Method: POST

    2. Relative URI: /httpconnectors

    3. Request body: Provide the configured schema details as the request body.

Important

After sending the API call, save the connector ID and connector version IDs (_id and versions[*]._id) from the response. You’ll need them to create a resource.

Warning

Do not attempt to create multiple connectors in the same API call. If you want to create multiple connectors you need to create them individually, meaning one API call for each connector. Do not create multiple connectors in one API call.

Get a connector

  1. Make a GET call to retrieve the connector ID from your list of HTTP connectors.

    1. Method: GET

    2. Relative URI: /httpconnectors

  2. Make a “get by ID” call to retrieve the connector’s details.

    1. Method: GET

    2. Relative URI: /httpconnectors/<connectorID>

Update a connector

  1. Make a GET call to retrieve the connector ID from your list of HTTP connectors.

    1. Method: GET

    2. Relative URI: /httpconnectors

  2. Make a “get by ID” call to retrieve the connector’s details.

    1. Method: GET

    2. Relative URI: /httpconnectors/<connectorID>

  3. Update your connector details in any editor.

  4. Make a PUT call to update your modified connector.

    1. Method: PUT

    2. Relative URI: /httpconnectors/<connectorID>

    3. Request body: Provide the edited details fetched from step 2.

    Tip

    Check the response body to validate your changes.

  5. Ensure that there are no corresponding changes needed for the resources or endpoints.

Resource

Learn more about resources.

Create a resource

  1. Download the Postman collection and open the httpconnectorresources schema.

  2. Create the connector’s resource using the schema.

    1. Method: POST

    2. Relative URI: /httpconnectorresources

    3. Request body: Provide the configured schema details as the request body.

      1. Provide the connector ID and connector version ID that you saved when you created the connector.

Important

After sending the API call, save the connector, connector version, and resource IDs from the responses. You’ll need them to create an endpoint.

Warning

Do not attempt to create multiple resources in the same API call. If you want to create multiple resources you need to create them individually, meaning one API call for each resource. Do not create multiple resources in one API call.

Get a resource

  1. Make a GET call to retrieve the resource ID from your list of HTTP resources.

    1. Method: GET

    2. Relative URI: /httpconnectorresources

  2. Make a “get by ID” call to retrieve the resource’s details.

    1. Method: GET

    2. Relative URI: /httpconnectorresources/<resourceID>

Update a resource

  1. Make a GET call to retrieve the resource ID from your list of HTTP resources.

    1. Method: GET

    2. Relative URI: /httpconnectorresources

  2. Make a “get by ID” call to retrieve the resource’s details.

    1. Method: GET

    2. Relative URI: /httpconnectorresources/<resourceID>

  3. Update your resource details in any editor.

  4. Make a PUT call to update your modified resource.

    1. Method: PUT

    2. Relative URI: /httpconnectors/<resourceID>

    3. Request body: Provide the edited details fetched from step 2.

    Tip

    Check the response body to validate your changes.

  5. Ensure that there are no corresponding changes needed for the endpoints.

Endpoint

Learn more about endpoints.

Create an endpoint

  1. Download the Postman collection and open the httpconnectorendpoints schema.

  2. Create the connector’s endpoint using the httpconnectors schema.

    1. Method: POST

    2. Relative URI:  /httpconnectorendpoints

    3. Request body: Provide the configured schema details as the request body.

      1. Provide the connector, connector version, and resource IDs that you saved when you created the connector and resource.

Warning

Do not attempt to create multiple endpoints in the same API call. If you want to create multiple endpoints, you need to create them individually, meaning one API call for each endpoint. Do not create multiple endpoints in one API call.

Get an endpoint

  1. Make a GET call to retrieve the endpoint ID from your list of HTTP endpoints.

    1. Method: GET

    2. Relative URI:  /httpconnectorendpoints

  2. Make a “get by ID” call to retrieve the endpoint’s details.

    1. Method: GET

    2. Relative URI: /httpconnectorendpoints/<endpointID>

Update an endpoint

  1. Make a GET call to retrieve the endpoint ID from your list of HTTP endpoints.

    1. Method: GET

    2. Relative URI:  /httpconnectorendpoints

  2. Make a “get by ID” call to retrieve the endpoint’s details.

    1. Method: GET

    2. Relative URI: /httpconnectorendpoints/<endpointID>

  3. Update your endpoint details in any editor.

  4. Make a PUT call to update your modified endpoint.

    1. Method: PUT

    2. Relative URI: /httpconnectors/<endpointID>

    3. Request body: Provide the edited details fetched from step 2.

    Tip

    Check the response body to validate your changes.

Related articles

Comments

0 comments

Article is closed for comments.