Skip to main content

​
Intro

JavaScript Object Notation (JSON) is a lightweight data-interchange format that is easy to use. The JSON No Code With Oauth connector allows you to import files from HTTPS sources using OAuth authentication. To learn more about the JSON API, visit their page https://jsonapi.org/. You connect to your JSON No Code OAuth account in the Data Center. This topic discusses the fields and menus that are specific to the JSON No Code OAuth connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Connector.

​
Prerequisites

To connect to your JSON No Code OAuth account and create a DataSet, you must add a JSON-OAUTH account and have the following:
  • Client Id
  • Client Secret
  • OAuth Type
  • Authorization URL
  • Access Token Url
  • Authorization type
  • Refresh Token Url
  • Scopes

​
Connecting to your custom data with the JSON No Code OAuth Connector

This section enumerates the options in the Credentials and Details panes in the JSON No Code OAuth Connector page. For detailed information on configuring the Data Selection, refer to the Connecting with the JSON No Code and JSON No Code OAuth connectors article. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in great detail in Adding a DataSet Using a Connector.

​
Creating a new JSON No Code OAuth Account Without Overwriting Existing Account

When creating a new account for the JSON No Code OAuth connector, If you don’t change the account name, then the existing account gets overwritten with the new credentials and this causes the other datasets and its connections to break. Follow the below steps to create a new account without overwriting the existing account:
  1. Click Add account.
  2. When you hover the cursor over the account name, you have the option to edit the account name.
  3. Add a new name account name, enter the remaining credentials and click Next.
The new account gets successfully added without overwriting the existing account.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your JSON No Code OAuth account. The following table describes what is needed for each field:
Field Description
JSON-OAUTH Account You can enter an account name of your choice.
Client ID Client ID for your OAuth authentication.
Client Secret Client Secret for your OAuth authentication
OAuth Type If your API does not specify the type of flow it uses, look for the ‘grant_type’ parameter required by the API to determine which flow to be used.
Authorization URL API authorization endpoint. This is the endpoint used for the first call in the OAuth handshake.
Additional parameters for the authorization url API call (optional) Add additional parameters required by your API to be used with the authorization URL (optional).
Access Token Url This endpoint will return the access token used to authenticate other API calls.
Additional parameters for the access token url API call
Add additional parameters required by your API to be used with the access token URL (optional).
Authorization type When you use the authorization code flow, rarely you need to pass the client id and secret in the header.
Refresh Token Url For most API, the refresh token url and the access token url are the same. Leave the input blank if this is the case.
Scopes (optional) Enter the scopes needed for this connection (optional). Scopes are usually separated by a space.
State Type Select the type of state required by your Oauth. (Rarely you need to modify this selection)
State Location Select if you want to send the state as a query parameter or in the path.
Response Type Select the response type you want to use with the authorization url (Rarely you need to modify this selection).
Use redirect uri when refreshing access token Select whether the redirect URI needs to be passed to the API when refreshing the access token (this is rare).
Force token refresh on every run Select this option if you want to refresh the access token for every run of the connector. This may be necessary if your token is regularly invalidated outside Domo, but this is rare.
The JSON No Code OAuth account connector uses OAuth to connect, so there is no need to enter the credentials for your authorization server within Domo. Click Connect (or select Add Account if you have existing JSON No Code OAuth accounts in Domo) to open the authorization server OAuth screen where you can enter your authorization server email address and password. Once you have entered valid JSON No Code OAuth credentials, you can use the same account any time you go to create a new JSON No Code OAuth DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.
Note: If you are already logged into your authorization server account when you connect in Domo, you are authenticated automatically when you click Add account. If you want to connect to an account that is different from the one you are logged into, you must first log out of your authorization server account.

​
Data Selection Pane

In this pane, you specify the server/SFTP site to connect to, the name of the JSON file, and other configuration settings.

Menu

Description

Choose the HTTP Method to use Choose from either GET or POST as the HTTP method.
Enter the URL to your JSON file Enter the URL of your JSON file.
How will you provide the certificate

Choose the method in which the certificate will be provided:

  • No certificate

  • URL Path to the Certificate

  • Certificate Content

​
Advanced Settings

Menu Description
HTTPS Headers Enter the Key and Value of the HTTPS Headers.
Query Parameters Enter the Key and Value of the Query Parameters. Specify whether you want to encode query parameters.
Date Query Parameters Select No Date Filter, Single Date, or Date Range as the Date Query Parameter.
JSON Settings Specify whether your JSON text requires a line reader and if the backslash character should be escaped.

​
Parsing

​
Pagination

Select how to paginate the data:
  • No Paging
  • Get next URL from results
  • Get next page token from results
  • Offset by records
  • Offset by pages

​
Parsing

Using the data preview, you can click on a column to format the data for parsing.

​
Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.

​
FAQ

Yes. To activate paging, select the paging type supported by your API and fill out the requested details.
  1. Select the column containing the data you want to expand or modify in the Parsing tab of the Parsing Pane.
  2. Hover over the suggested actions to see the effect and click on the desired action.
  3. Repeat until the data looks the way you want it to look.
  4. Use the history section on the right to undo actions if needed.