Rights of interface resources page
Opening API traffic
- General access rights
- Finished integrations
- Custom integrations
Closing API traffic

Netvisor API interface allows versatile data transfer. To transfer data to or from Netvisor, API traffic must be opened. API traffic is opened by allowing rights of interface resources either specifically for integrations or generally. General or integration-specific rights act as passes that can be defined as needed. In addition to rights of interface resources, company-specific API identifiers are always required, so merely granting rights of interface resources does not open the API for all our integration partners.

To edit rights of interface resources, User administrator (KH) rights or Accounting office’s administrator (TPK) rights are required. Additionally, the user must have a defined operational right to edit interface resources. If the user's profile states "No rights", resource editing is not allowed.

The software interface service is included in Professional, Premium, and Payroll packages. Netvisor Store extensions, importing invoice material in finvoice format, and Smart Excel forms can also be used with Basic and Core packages.

Transaction-based interface resources are:- Importing an attachment voucher (accounting.nv)- Importing a purchase invoice (purchaseinvoice.nv)- Importing an eScan document (eScan.nv)Other interface resources are included in the service package's monthly pricing.

Allowing access rights does not automatically update the company to Professional, Premium, and Payroll packages. The package update must always be done separately from Netvisor Store.

Rights of interface resources page

The rights of interface resources page is a tool for companies to manage what data can be transferred via the API. The page shows all added access rights and all available resources, categorized.

A resource refers to a function offered by the API that allows data to be exported to or imported from Netvisor.

You can find the rights of interface resources view: Company menu > Rights of interface resources.

The rights of interface resources page is divided into three panels: Integrations, API traffic, and Resource access rights. “Integrations” panel lists all integrations that have been given specific rights or restrictions (below in image section 1). “Rights of interface resources” panel lists all available resources by category (2). Rights can be allowed either resource-specifically or by category. "API traffic" panel allows closing the use of API traffic entirely (3).

"Integrations" panel allows choosing whether access rights are enabled specifically for integrations or general API traffic rights are allowed. The panel lists all integrations that have already been given rights or restrictions. Integration-specific rights override general access rights.

tietoturvapaneeli2.png

An exclamation mark inside a triangle after the integration name indicates that only some resources are allowed or the integration has a limited number of resources available. If an integration has a limited number of resources available, the integration needs all available resources to function correctly.
An exclamation mark inside an octagon after the integration name indicates that all resources are blocked for that integration, meaning API traffic is closed.

Note! Once an integration is added to the list, it cannot be removed. If a wrong integration is added by mistake, block all resources for that integration.

Integrations are divided into three types in the panel: General access rights, Finished integrations, and Custom integrations.
K_ytt_oikeudet.jpg

  • Finished integrations
    • Under this header, all added finished integrations are shown. Unique rights can be given to each integration, determining what data the integration can export and import via the API. Integration-specific rights override general access rights. Note, if no integration-specific rights are given to a resource, its use is blocked for that integration even if it is allowed in general rights.
    • Finished integrations can be found from Netvisor Marketplace. To start using a finished integration, you must first contact the integration vendor. You can contact the integration vendor through Netvisor Marketplace. Note that there may be additional charges from the software vendor for integrations.
  • Custom integrations 
    • Under this header, all added custom integrations are shown. Unique rights can be given to each integration, determining what data the integration can export and import via the API. Integration-specific rights override general access rights. Note, if no integration-specific rights are given to a resource, its use is blocked for that integration even if it is allowed in general rights.
    • A custom integration is a company's own implementation or a version tailored to the company's needs. To enable this integration, you need an access key provided by the integration vendor.
  • General access rights
    • General access rights apply if no specific rights are allowed for an integration. We strongly recommend that integration rights are always allowed specifically for integrations, not with general access rights.

Rights of interface resources panel is categorized according to Netvisor sections. For example, under Sales, you can find resources related to customer data, orders, invoices, and sales performance.

Each resource shows its status: allowed or blocked, and an info button. The info button opens a window explaining the purpose of the resource (below in image section 1). The window also contains a link to the technical resource description on our help pages.
Resurssin_tiedot.jpgGeneral access rights selection also shows integration-specific rights in section-specific settings. The integration-specific rights column shows how many integrations have the resource available (2), and clicking the number shows the resource status integration-specifically. Clicking the integration name takes you to the section-specific settings for that resource.

You can also access section-specific settings for integrations by selecting the desired integration from the integrations panel on the left.

Opening API traffic

API traffic is opened by allowing rights of interface resources either specifically for integrations or generally.

General access rights can be allowed resource-specifically or section-specifically. You can open a section by clicking the button “Whole section blocked” on the right. The button then slides to the right, turns blue, and the text changes to “Section allowed”. At the same time, all resource buttons in the section turn blue “Allowed” buttons.

Finished integrations are added to the list by searching for them by name. Select "Finished integrations" and type the integration name in the search field below (image below). Clicking the correct integration name from the list allows you to set access rights for that integration.
Valmiit_integraatiot.jpg

After clicking the integration name, it appears in the Resource access rights panel in the bar above (image below section 1). The whole integration is allowed by clicking the button “Integration blocked” on the right (2). Clicking the button turns it blue and changes the text to “Integration allowed”. This saves the integration access rights, and the integration name also appears under the “Finished integration access rights” header in the “Integrations” panel. If only certain resources are to be allowed for the integration, click the “Blocked” button next to the resource (3), which turns the button blue and changes the text to “Allowed”.

K_ytt_oikeuksien_salliminen.jpg

Custom integrations are added to the list by searching for them with the identifier, i.e., the access key provided by the integration vendor. Select "Custom integrations", enter the access key in the search field below, and press the "Search" button. You can then set access rights for that integration. 

R__t_l_idyt_integraatiot.jpg

After clicking the "Search" button, the integration name appears in the "Resource access rights" panel in the bar above (image below section 1). The whole integration is allowed by clicking the button “Integration blocked” on the right (2). Clicking the button turns it blue and changes the text to “Integration allowed”. This saves the integration access rights, and the integration name also appears under the “Custom integration access rights” header in the “Integrations” panel. If only certain resources are to be allowed for the integration, click the “Blocked” button next to the resource (3), which turns the button blue and changes the text to “Allowed”.

K_ytt_oikeuksien_salliminen_r__t_l_idyt.jpg

Closing API traffic

The whole API traffic can be closed by opening the Company menu "Rights of interface resources" and pressing the "Block API traffic" button in the "API traffic" panel.

API traffic can alternatively be closed by blocking all resources for all integrations. When all resources are blocked, the "Block API traffic" button turns grey.

A single integration can be closed by selecting the integration name from the "Integrations" panel and blocking all resources from the "Resource access rights" panel. An exclamation mark inside an octagon appears after the integration name when all resources are blocked for the integration.

This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.