Skip to main content

Symon.AI Help Center

REST API

Abstract

Connect Symon.AI to a REST API or REST-based connector to import your data.

Connect Symon.AI to a REST API or REST-based connector to import your data.

Note

If you are connecting with OAuth client code, you must ensure that you configure your third-party server first. For more information, see Configuring OAuth client code.

Importing data

  1. In Symon.AI, go to the Data tab.

  2. Click Import data.

  3. In the Third party sources section, click REST API, or any other REST-based connection available.

    Note

    All REST-based connector tiles appear after the REST API tile.

    connectorsrestapi.png

  4. Click New connection.

  5. On the Connect to your API page, enter the following information to connect:

    Table 17. Generic REST or REST API connector

    Field

    Description

    Connector name

    The name of the connection.

    Authentication method

    The method to use to authenticate with your REST API. Choose one of the following options:

    • None: There is no authentication method.

    • Basic: Enter your Username and Password.

    • API key: Enter the Authentication header, such as Authorization: Bearer <api-key-value>

    • OAuth client credentials: Enter the Authentication URL, Token type, Key and Secret.

    • OAuth client code: Enter the Third-party authentication URL, Access token URL, Scope, Client ID and Client secret.

    Endpoint URL

    The URL for the REST API, which can contain path and query parameters, such as https://yourwebsite/com/api/v2/tickets.

    Path to data

    A JSONPath formatted string that locates the desired data from the payload returned from the REST API. Learn more. For example, if the REST API returns a payload like this:

    pathtodataexample.png

    Your Path to data would then look like this: $.results.rows.

    Flatten

    Select Flatten if each row of data that is being returned from the REST API, at the path that you specified in Path to data, is formatted as a multi-level object, and should be flattened to a single-level object before being processed.

    Table key

    The name of the identifier or key column in your expected data, such as ID.

    Pagination

    Select one of the following pagination types:

    • Paged: Select this option if the REST API supports basic pagination.

      • First page number: The page number that you want to retrieve first. Pages occurring before this number are not retrieved.

      • Request page label: The name of the field that specifies the page number in requests to the REST API.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.

    • Offset: Select this option if the REST API supports paging where you can specify the page size.

      • Page size: The number of entries that you want in each page.

      • Request page size label: The name of the field that specifies the page size in requests to the REST API.

      • Path to offset: A JSONPath formatted string that locates the current offset amount from the payload returned from the REST API. Learn more.

      • Request offset label: The name of the field that specifies the offset in the request to the REST API.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.

    • Cursor: Select this option if your REST API supports cursor-based paging.

      • Page size: The number of entries that you want in each page.

      • Request page size label: The name of the field that specifies the page size in requests to the REST API.

      • Request cursor label: The name of the field that specifies the cursor value in requests to the REST API. Cursor values are taken from the column given in the Table key.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.



  6. Click Next.

  7. On the Choose data sets page, select one or more data sets to include. Click Next.

  8. On the Import data page, configure the column type and obfuscation. Click Next.

  9. On the Review page, review the data sets that you are importing.

    The data is available on the My Data page.

Configuring OAuth client code

Abstract

You can create a REST API connector to authenticate with OAuth2, using either Client Code or Client Credentials.

Create a REST API connector to authenticate with OAuth2, using either Client Code or Client Credentials. Configuring the REST connector to authenticate with OAuth2 allows your third-party to grant, limit and revoke access.

Preparing the third-party application

  1. Register your Symon.AI account with your desired third-party application.

  2. Configure the third-party application to recognize the Symon.AI call-back URL.

    Note

    The callback URL will be in the form of https://<your-elt.varicent.com-base-url>/importRedirect. For example, if you access Symon.AI at https://elt.varicent.com, your callback URL is https://elt.varicent.com/importRedirect.

  3. Get a Client ID and Client Secret from the third-party application.

  4. Grant sufficient privileges to allow Symon.AI access the third-party application data.