SnapLogic Public APIs

Overview

SnapLogic Public APIs provide basic functionality that you can use to programmatically manage your integration.

  • The timeout for these APIs is set to 15 minutes. You can change this timeout on the client-side network, but it remains 15 minutes in the SnapLogic Platform.

  • The total API limit is affected by triggered Pipeline executions only; it is not affected by the use of SnapLogic Public APIs.

You can also create your own custom APIs from your Pipelines using the API Management tool.

Authentication

API requests are authenticated using basic authentication over HTTPS. Future updates might include additional authentication methods.

You can run these APIs regardless of the permissions or user roles assigned to you in your Org. Access to the information returned by these APIs is based on asset permissions, which are set in SnapLogic Manager.

If your SnapLogic account is locked or your password is expired, you cannot invoke SnapLogic Public APIs.

Best Practices

  • If an API requires a reference to an account asset, refer to the Account instance by its asset ID, instead of its label. You can find the asset ID of an Account instance from the Pipeline's metadata.

    1. Export the Pipeline to view its metadata. The .slp file generated by the export is a JSON-formatted file.

    2. In the JSON tree, under snap_map, go to the branch for the Snap that uses the modified Account.
      TIP: Under snap_map, the keys are the Snap asset IDs. Use the Snap's class_fqid and class_id to help you find the appropriate Snap.

    3. Under the appropriate Snap's branch, the Account's asset ID is the value of property_map.account.account_ref.value.ref_id.value.

API Reference

SnapLogic provides the following APIs: