Getting Started

Welcome to getting started with InterlaceIQ.

InterlaceIQ is a an API & Integration Platform to make it easier to connect and integrate with external APIs.

Creating your first project

  • •To create your first project, navigate to the Projects page.
  • •Click on the 'New Project' button on the Projects page.
  • •Fill out the project details such as the project name.
  • •Click on the 'Create' button to create your project.
  • •Once your project is created, click on the projects name, you can start adding nodes to your project.
  • •Well done! You have successfully created your first project in InterlaceIQ, now its time to build some integrations.
Simple Cat Integration

Creating a simple integration

  • 1Setup the API Endpoint node
    • 1.1Drag an API Endpoint node onto the canvas
    • 1.2Set the node name 'Get cat fact'
    • 1.3Set the URL path to '/get-cat-fact'
    • 1.4Set the request type to 'GET'
    • 1.5Click update
  • 2Setup the Requester node
    • 2.1Drag a Matcher node onto the canvas
    • 2.2Set the node name 'Extract cat fact'
    • 2.3Set the URL path to 'https://catfact.ninja/fact'
    • 2.4Click the 'From Response' as we are getting the response data from the Requester node'
    • 2.5Click the drop down, and click 'New Key'
    • 2.6Set Key to 'fact' as that will be the response from the API
    • 2.7Click the 'Use' checkbox
    • 2.8Set 'Variable' to 'catFact' as that will be the variable name
    • 2.9Set the 'Type' to STRING
    • 2.10Click update
    • 2.11Setup the Condition node
  • 3Setup the Condition node
    • 3.1Drag a Condition node onto the canvas
    • 3.2Set the node name 'Check if cat exists'
    • 3.3Add a new condition, with {{catfact}} as string on the left, and 'cat' as string on the right
    • 3.4In the same condition, set the comparison to '⊃' so we will check if the text contains 'cat'
  • 4Setup the API Response node for default
    • 4.1Drag a API Response node onto the canvas
    • 4.2Set the node name 'cat exists'
    • 4.3Set the status code to 200
    • 4.4Set the response type to 'JSON'
    • 4.5In the JSON editor, enter { "fact": {{catfact}} }
    • 4.6Click update
  • 5Setup the API Response node for if cat exists
    • 5.1Drag a API Response node onto the canvas
    • 5.2Set the node name 'No cat exists'
    • 5.3Set the status code to 404
    • 5.4Set the response type to 'JSON'
    • 5.5In the JSON editor, enter { "error": "No cat exists" }
    • 5.6Click update
  • 6Wrapping things up
    • 6.1You now have all the nodes setup for the integration
    • 6.2Click save on the action bar, or click file then save
    • 6.3Let's run the project, click, run, on the action bar, or deployment, then run
    • 6.4Make sure you click on your API Endpoint, and copy the curl, then import it into a program called Postman, then test the API call
    • 6.5You should then get a response every time the word 'cat' appears in the response, otherwise, it will send a 404
Simple Cat Integration