Skip to main content

Data Source

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

SpotDraft API

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 SpotDraft connector tile from the list of available connectors. Then, select the credential that will be used to connect to your SpotDraft account, and click Next; or, create a new SpotDraft credential for use in this flow.

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

    SpotDraft sources can also be configured manually, allowing you to ingest data from SpotDraft 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 SpotDraft endpoints. Each template is designed specifically for the corresponding SpotDraft 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.

    Gets the list of all the users in the Client's account.

    This endpoint template retrieves a list of all users in your SpotDraft account. Use this template when you need to retrieve information about users, including user IDs, email addresses, and other user metadata.

    • This endpoint automatically retrieves all users from your SpotDraft account. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns a list of all users in your SpotDraft account, including user IDs, email addresses, and other user metadata. The endpoint uses incrementing page-based pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

    For detailed information about users, API response structures, pagination, and available user data, see the SpotDraft API documentation.

    Get contacts

    This endpoint template returns the list of contracts belonging to the related workspace from your SpotDraft account. Use this template when you need to retrieve information about contracts, including contract IDs, details, and other contract metadata.

    • Enter the Client Email in the Client Email field. This should be the email address of the client whose contracts you want to retrieve. The Client Email is used as a filter to retrieve contracts for a specific client. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns the list of contracts belonging to the related workspace from your SpotDraft account, including contract IDs, details, and other contract metadata. The endpoint uses incrementing page-based pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

    The Client Email is used as a filter to retrieve contracts for a specific client. For detailed information about contracts, API response structures, pagination, and available contract data, see the SpotDraft API documentation.

    Get Counterparties

    This endpoint template retrieves the list of counterparties from your SpotDraft account. Use this template when you need to retrieve information about counterparties, including counterparty IDs, names, and other counterparty metadata.

    • Enter the Client Email in the Client Email field. This should be the email address of the client whose counterparties you want to retrieve. The Client Email is used as a filter to retrieve counterparties for a specific client. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns the list of counterparties from your SpotDraft account, including counterparty IDs, names, and other counterparty metadata. The endpoint uses incrementing page-based pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

    The Client Email is used as a filter to retrieve counterparties for a specific client. For detailed information about counterparties, API response structures, pagination, and available counterparty data, see the SpotDraft API documentation.

    Get Counterparty contacts

    This endpoint template retrieves the list of counterparty contacts from your SpotDraft account. Use this template when you need to retrieve information about counterparty contacts, including contact IDs, names, and other contact metadata.

    • Enter the Counterparty ID in the Counterparty ID field. This should be the unique identifier of the counterparty whose contacts you want to retrieve. The Counterparty ID determines which counterparty's contacts will be retrieved. You can find the Counterparty ID by using the "Get Counterparties" endpoint. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns the list of counterparty contacts from your SpotDraft account, including contact IDs, names, and other contact metadata. The endpoint uses incrementing page-based pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

    The Counterparty ID can be found by using the "Get Counterparties" endpoint. For detailed information about counterparty contacts, API response structures, pagination, and available contact data, see the SpotDraft API documentation.

    Get Counterparty Addresses

    This endpoint template retrieves the list of counterparty addresses from your SpotDraft account. Use this template when you need to retrieve information about counterparty addresses, including address IDs, addresses, and other address metadata.

    • Enter the Counterparty ID in the Counterparty ID field. This should be the unique identifier of the counterparty whose addresses you want to retrieve. The Counterparty ID determines which counterparty's addresses will be retrieved. You can find the Counterparty ID by using the "Get Counterparties" endpoint. The endpoint uses incrementing page-based pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns the list of counterparty addresses from your SpotDraft account, including address IDs, addresses, and other address metadata. The endpoint uses incrementing page-based pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page parameter.

    The Counterparty ID can be found by using the "Get Counterparties" endpoint. For detailed information about counterparty addresses, API response structures, pagination, and available address data, see the SpotDraft 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​

SpotDraft data sources can be manually configured to ingest data from any valid SpotDraft 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 SpotDraft sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

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 SpotDraft API from the Method pulldown menu. SpotDraft API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the SpotDraft API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your SpotDraft endpoint (e.g., https://api.spotdraft.com/api/v2/public/auth/users, https://api.spotdraft.com/api/v2/public/contracts). Include any required path parameters or query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The SpotDraft API endpoint URL should include the API base URL (https://api.spotdraft.com/api/v2/public/) and the resource path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For SpotDraft API responses, use $.results[*] to extract all items from the results array, or $[*] to extract all items from the response array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your SpotDraft API response. SpotDraft API responses typically have a results array containing the data records. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. SpotDraft API uses incrementing page-based pagination with page and limit parameters for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page parameter name (page), page size parameter name (limit), and starting page number.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.