Skip to main content

Webdam Data Source

Follow the instructions below to create a new data flow that ingests data from a Webdam source in Nexla.
webdam_api.png

Webdam

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Webdam connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Webdam instance, and click Next; or, create a new Webdam credential for use in this flow.

  3. In Nexla, Webdam data sources can be created using pre-built endpoint templates, which expedite source setup for common Webdam endpoints. Each template is designed specifically for the corresponding Webdam endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

Webdam sources can also be configured manually, allowing you to ingest data from Webdam endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Webdam endpoints. Each template is designed specifically for the corresponding Webdam endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Search Assets

    This endpoint template searches assets in DAM by text from your Webdam account. Use this template when you need to search for assets, filter assets by criteria, or retrieve asset metadata based on search queries for analysis, reporting, or integration purposes.

    • Select the Sort Order from the Sort Order pulldown menu. This should be the sort order value that determines how search results will be sorted. You can select from the available options: asc (ascending order) or desc (descending order). The default value is asc.
    • Select the Sort By Value from the Sort By Value pulldown menu. This should be the field to sort the assets. You can select from the available options: filename (File name), filesize (File size), datecreated (Created date of assets), or datemodified (Modified date of assets). The default value is filename.
    • Enter the Text to query in the Text to query field. This should be the search text that will be used to search for assets. The Text to query determines which assets will be retrieved based on the search criteria.
    • Enter the Folder ID in the Folder ID field. This should be the folder ID that limits the search to a specific folder. The Folder ID determines which folder's assets will be searched.

    This endpoint searches assets in DAM by text from your Webdam account, including asset IDs, filenames, metadata, and other asset information. The endpoint uses offset-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of search results.

    For detailed information about asset search, API response structures, pagination, and available asset data, see the Webdam API documentation.

    Get resources

    This endpoint template gets resources from your Webdam account. Use this template when you need to access resource information, resource details, or resource metadata for analysis, reporting, or integration purposes.

    • Enter the Resource Type in the Resource Type field. This should be the type of resource you want to retrieve (e.g., folders, assets, etc.). The Resource Type determines which type of resources will be retrieved.

    This endpoint gets resources from your Webdam account, including resource IDs, names, metadata, and other resource information. The endpoint retrieves resources based on the specified resource type.

    For detailed information about resources, API response structures, and available resource data, see the Webdam API documentation.

    Download Asset

    This endpoint template downloads an asset from your Webdam account. Use this template when you need to download asset files, retrieve asset content, or access asset binary data for analysis, reporting, or integration purposes.

    • Enter the Asset ID in the Asset ID field. This should be the unique identifier of the asset you want to download. The Asset ID determines which asset will be downloaded.

    This endpoint downloads an asset from your Webdam account, including the asset file content and metadata. The endpoint retrieves the asset file based on the specified asset ID.

    For detailed information about asset downloads, API response structures, and available asset data, see the Webdam API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Webdam data sources can be manually configured to ingest data from any valid Webdam API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Webdam sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Webdam API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most common for Webdam data sources)

API Endpoint URL​

  1. Enter the URL of the Webdam API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Webdam API endpoints typically follow the pattern https://apiv2.webdamdb.com/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth2 authentication, which is handled automatically by your credential configuration.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of assets, the API will typically return an array of asset records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Webdam API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.items[*] to access an array of assets within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/assets/asset to access asset elements within an assets element).

    Path to Data Example:

    If the Webdam API response is in JSON format and includes a nested array named items that contains the relevant data, the path to the response would be entered as $.items[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Webdam data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.