App

Register an app link

You can register a link in a specific menu in Silverfin to send a user from a context in Silverfin to your service or app. This can be useful for things like e-signing flows, data integrations and more. Please keep in mind that AppLinks are scoped to users, meaning only the user who creates them has permissions to delete them. Also, fetching the list of AppLinks will return those created by the user making the request. <br>

Adding AppLinks as a partner

If you're a partner, the placement options for marketplace reconciliation text and/or export files is the one you will need if you want to add a link for a globally managed template across firms. The marketplace placement options should only be used for integrations that are meant for the vast majority of Silverfin's users. Please contact Silverfin to request the necessary ids in such cases. Since a marketplace reconciliation text/export file/report is globally managed and used across multiple firms, this means that when this option is used, the AppLink will be shown in the menu of all companies, and for every firm that uses this marketplace export file. For the ids in the placement options, you can provide a single id value or multiple values. In case you omit the value (no id added) for the placement options, your AppLink will be added to ALL templates of that placement. <br> <b>Required scope(s):</b> links

post/api/v4/f/{firm_id}/app/links

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/app/links
  • Auth
    OAuth 2
    Authorization code: https://live.getsilverfin.com/oauth/authorize
    Token URL: https://live.getsilverfin.com/oauth/token scopes: links

Path parameters

firm_idstring required

Headers

Acceptstring

Request body multipart/form-data

name_nlstring

Name of the link the user will see in NL (max. length 25)

name_frstring

Name of the link the user will see in FR (max. length 25)

name_dastring

Name of the link the user will see in DA (max. length 25)

name_enstring

Name of the link the user will see in EN (max. length 25)

target_urlstring

The url the user should be forwarded to when clicking the link in the menu

placement'firm_landing_action_menu' | 'workflow_action_menu' | 'export_file_action_menu' | 'period_action_menu' | 'reconciliation_action_menu' | 'permanent_text_action_menu' | 'permanent_folder_action_menu' | 'report_action_menu' | 'mapping_action_menu' | 'export_action_menu'

The menu in which the link should be shown within Silverfin, you can only add one placement per request

placement_options[firm_workflow_ids][]string

An id representing a workflow on firm-level. Use with the 'workflow_action_menu' placement.

placement_options[marketplace_export_file_ids][]string

An id representing an export file that is managed at the global level for all partners. Use with the 'export_file_action_menu' placement.

placement_options[export_file_ids][]string

An id representing an export file managed on firm-level. Use with the 'export_file_action_menu' placement.

placement_options[marketplace_reconciliation_ids][]string

An id representing a reconciliation text managed on partner-level. Use with the 'reconciliation_action_menu' placement.

placement_options[reconciliation_ids][]string

An id representing either a reconciliation text within a firm or the id of a reconciliation text within a company. Use with the 'reconciliation_action_menu' placement.

client_file_type'regular' | 'analytical' | 'consolidation' | 'sole_trader' | 'personal'

Limit the app link to only be shown in a specific client type

open_in_new_tabboolean

Response

Successful response

idinteger

app_link_id

namestring
name_nlstring
name_frstring
name_enstring
name_dastring
target_urlstring
placementstring

Changes

No recorded changes to this operation across all 2 revisions of this API.