HTTP client as a source

Select the HTTP client endpoint to load data using an API call. AutoSync attempts to infer data types from the results. Numbers might be float or int, which AutoSync stores in the target as float. AutoSync stores strings that appear to be timestamps as Timestamp.

Supported load types

The HTTP client supports Full load. On synchronization, AutoSync drops the table and reloads.

Supported account types

To provide connection information, you can enter credentials in AutoSync, Designer, or Classic Manager. Designer and Classic Manager offer multiple account types for most endpoints and not all types are compatible with AutoSync. When you create or edit a data pipeline, the existing credentials list includes only compatible account assets. AutoSync supports the following Designer and Classic Manager account types:

• API Suite—Google Service Account
• AWS Signature V4 Account
• Basic Authentication Account
• Digest Authentication Account
• NTLM Account
• OAuth2 Account
• Secured Headers Account
• SSL Account
• SSL OAuth2 Account

Credentials that you create in AutoSync use basic authentication. If you need to use one of the other account types, for example to supply a secure header, you must create the account in Classic Manager or Designer. The Accounts created in Classic Manager or Designer for the HTTP Client must specify a tag for AutoSync. In the Info tab of the account, enter autosync_httpclient in the Tags field.

Known limitations

• The API must return data in JSON format.
• The HTTP client endpoint doesn't paginate results.
• Each data pipeline loads one table.
• To use accounts created in Classic Manager or Designer, you must add an autosync_httpclient tag in the Info tab.

Connection configuration

When you create or edit credentials in AutoSync, properties include the following:

• Credential label: A unique, meaningful name such as Google-service-account. If a configuration with the same name exists, AutoSync displays an Asset conflict error message.
• Username: The username for an account with the correct permissions to write data. For example Sales-admin.
• Password: The password for the account. Multiple retries with an invalid password can cause your account to be locked.
• Share: (Optional) Select a user group to share this configuration with. Org admins create user groups to share credentials. If you are a member of a user group, you can select it from the dropdown. You can also select the global shared folder, which shares the credentials with everyone in your Org.
• Validate and Save: After saving and validating, AutoSync adds the configuration to the list of saved credentials.

After validating the credentials, enter values for:

• URL: The source address followed by the API call. For example, https://www.googleapis.com/calendar/v3/calendars/calendar_id/events
• Path to data: To retrieve an object in the response, enter the path. For example, the path to the data for the following structure is results:

  {
    "count": 1302,
    "next": "URL",
    "previous": null,
    "results": [
              ...
     ]
  }
            

  In the following example, the results object is nested under data. The path value is data.results:

  {
    "status": "SUCCESS",
     "data": {
        "count": 1302,
        "next": URL
        "previous": null,
        "results": [
                ...
         ]
      }
  }

• Destination table name: The name of the table to create in the target. For example, Calendar.