{"id":29561,"date":"2021-08-11T18:48:50","date_gmt":"2021-08-11T17:48:50","guid":{"rendered":"https:\/\/multisite.korebots.com\/v9-0\/?p=29561"},"modified":"2021-08-11T18:51:52","modified_gmt":"2021-08-11T17:51:52","slug":"connect-to-api","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/docs\/process-apps\/flow\/integrations\/connect-to-api\/","title":{"rendered":"Connect to API"},"content":{"rendered":"

Connect to API<\/span><\/i> integration is a service request made to a third-party application to help both applications communicate with each other to share the necessary information. With the <\/span>Connect to API<\/span><\/i> integration, you can access and send data from\/to third-party applications<\/span>. <\/span>It allows you to perform the following actions:<\/span><\/p>\n

    \n
  • Get<\/span><\/li>\n
  • Post<\/span><\/li>\n
  • Put<\/span><\/li>\n
  • Patch<\/span><\/li>\n
  • Delete<\/span><\/li>\n<\/ul>\n

    To configure Connect to API and perform actions, follow the below steps:<\/span><\/p>\n

      \n
    1. On the left pane, you can find the <\/span>Integrations <\/b>section. Drag and drop the <\/span>Connect to API <\/b>stencil from this section to the builder.<\/span><\/li>\n
    2. Click the <\/span>Connect to API <\/b>stencil to open the Connect to API<\/span> window.<\/span><\/li>\n
    3. On the Connect to API<\/span> window, configure the following details:<\/span>\n
        \n
      1. Name – Enter a name for this task<\/span><\/li>\n
      2. Type – Select the API type (REST\/SOAP) from the drop-down list.<\/span><\/li>\n
      3. Integration Mode – Select the integration mode: Synchronous or Asynchronous.<\/span><\/li>\n
      4. URL – Click <\/span>Define Request<\/b> to define a service request. The <\/span>Define Request for the task<\/span><\/i> page is displayed. From the first drop-down list, select the HTTP method used for the request. You can select:<\/span>\n
          \n
        1. POST <\/b>– Used to send data to the server. For example, customer information, file upload, and so forth using HTML forms.<\/span><\/li>\n
        2. PUT <\/b>– Replaces the content of the target resource with the content sent.<\/span><\/li>\n
        3. PATCH <\/b>– Appends the content of an existing target resource with the content sent.<\/span><\/li>\n
        4. DELETE <\/b>– Deletes the content of an existing target resource.<\/span><\/li>\n
        5. GET <\/b>– Returns the content of an existing target resource.<\/span><\/li>\n<\/ol>\n<\/li>\n
        6. In the <\/span>URL <\/b>field, specify a URL.<\/span><\/li>\n
        7. In the <\/span>Headers <\/b>tab, specify the headers as key\/value pairs if required to access the specified request URL.\u00a0<\/span><\/li>\n
        8. Click the <\/span>Test Request<\/b> tab.<\/span><\/li>\n
        9. Click <\/span>Test <\/b>to send your API request URL using the specified HTTP headers and body parameters, if defined. The response is displayed in the text area.\u00a0<\/span><\/li>\n
        10. Click <\/span>Save<\/b> to save the test response as the sample response. Also, the Define Request page automatically exits after you save the response.<\/span><\/li>\n<\/ol>\n<\/li>\n
        11. Under the <\/span>Access using a Connector<\/b> section, you can select\/clear the <\/span>Yes, URLs are behind a firewall and a connector has been setup<\/b> checkbox.<\/span><\/li>\n
        12. Close the Connect to API window.<\/span><\/li>\n<\/ol>\n<\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Connect to API integration is a service request made to a third-party application to help both applications communicate with each other to share the necessary information. With the Connect to API integration, you can access and send data from\/to third-party applications. It allows you to perform the following actions: Get Post Put Patch Delete To...","protected":false},"author":12,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[154],"tags":[],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/29561"}],"collection":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/comments?post=29561"}],"version-history":[{"count":1,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/29561\/revisions"}],"predecessor-version":[{"id":29562,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/29561\/revisions\/29562"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/media?parent=29561"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/categories?post=29561"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/tags?post=29561"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}