Guidelines and best practices
Owner vs developer of application
This article intend to clarify how PowerOffice view the relation between the developer of the integration, the "owner" of the integration (signing the Visma Developer Terms), and how this correspond with application keys and subscription keys.
General definitions
Application key & ownership
The application key is a fixed key that identify a given integration. A given integration is created by PowerOffice with a set of variables, including but not limited to name, contact information, api access privileges and various settings.An external party must claim ownership of the application key, in terms of responsibility for the use, api access, maintenance and support - and also be our main point of contact for any needed technical dialogue. We refer to this party as the legal owner, and this party must sign the Visma Developer Terms.
Subscription key & ownership
The subscription key is a fixed key that identify a unique subscription to our api v2, and the subscription hold technical properties such as rate limits and quotas. All api v2 request must include the subscription key in the header.The subscription key is needed by the technical provider of the integration, and is generally "owned" by this party in terms of responsibility.
Application owner vs subscription owner
A third party may choose to integrate it's system with PowerOffice and request access to the api. Regardless of whether or not the integration is meant to be public or for internal use only, the third party will naturally be viewed as the owner of the application key created. However, the third party might need to use an external developer to develop and maintain the integration. This external developer will be responsible for their subscription key needed for the case.
The relationship of the keys
A subscription key kan be used with/for many application keys. An application key can only be used with one subscription key.
Examples of use cases
One integration: The owner and developer are the same
This is the common usecase. An external software party contact us in order to integrate their system with PowerOffice, and they have in-house developers and technical expertise.This party is both the legal owner of the application and the developer, will sign the Visma Developer Terms and receive both an application key and a subscription key.
One integration: The owner and developer are different
This is the second most common case. An external software party contact us to integrate their system with PowerOffice, but they will use a third party to develop and maintain the integration.The external software party will be the owner of the application and sign the Visma Developer Terms, but we will register the developer company and provide the subscription key to this party.
General providers of integrations with Go
Some third parties specialize in creating integrations between systems and PowerOffice. These actors may have one subscription key and many application keys. They can have these situations:Be the owner of all the application keys
Be developer of the integrations with other parties owning the applications keys
Combine the two points above depending on the use cases