Step 1

These steps below are common for both Push/Pull connectors.

  1. Connector Name: This can be anything you choose, but we recommend using the name of the service/server that you’re connecting to; that way, you can recognize which connector does what, if you have multiple connectors setup.

  2. Authentication: Authentication will verify the user before an external server can allow them access. Grid supports the following types of authentication:

    • No Auth: Choose this if the API you’re connecting to does not have any authentication or security.

    • API Key: Choosing this option gives you a new field to input your API key and value; you also have to select whether the API Key is to be sent in the header of the request, or sent as a Query Parameter. (The systems administrator or help documentation of the external server or service you want to connect to will have details on this)

    • Bearer Token (gives you a new field to input your Bearer Token)

    • Basic Authentication (gives you two new fields to input your username and password.)

    • To know about OAuth or API auth methods, click on the buttons below.

  3. Configuration: Here, you configure the test connection to ensure the functionality of API connector. There are two parts:

    • HTTP Request - using this, you (an app or system) communicate with a server to ask for data or perform actions. We support these:

      • GET (retrieve data)

      • POST (submit data)

      • PUT (update data)

    • Endpoint - you insert the URL here to either push or pull data from the external server.s