How to start using the interfaces
The purpose of this article is to list all the different stages which are needed to start using the Vero API -interfaces. Different stages and the instructions related to them, are listed to an order, which is recommended to follow.
1. Get to know Vero API interfaces
It is recommended to read all the general and technical instructions before starting to develop or testing the interface integration.
- General instructions: What are the Vero API interfaces - vero.fi
- Technical instructions: Technical guidance - vero.fi
- Acting on behalf of other organizations and authorizations: Acting on behalf of other organizations - vero.fi
2. Try the interfaces in Sandbox
In the sandbox, developers can explore the current and future interfaces of the Vero API.
- URL of the interfaces: api-sandbox.vero.fi
- The user registers to the sandbox and receives a separate API key (Subscription key) that is used only in the sandbox.
- Discover and test the API services in the Sandbox - vero.fi.
3. Software registration in the API portal and API key
The purpose of the software registration is to improve the user experience of interfaces and the quality of integrations through a standardised deployment process and targeted guidance.
- The software is registered in the portal, after which the user receives an API key, which is required for the production use of the interfaces.
- It is recommended to register in the portal before starting to test the interfaces.
- For more detailed instructions: Software registration and acceptance procedure - vero.fi
4. Testing interfaces and retrieving the test certificate
Testing ensures that the integration between the software and the Tax Administration work without any unexpected errors.
- You will need a test certificate from the Certificate service.
- The API key from the API portal is provided in the Vero-SoftwareKey header.
- For interface documentation and test environment addresses you can find in the Vero API Portal (URL Test)
- Testing instructions: Vero API - Test and develop in the testing environment - vero.fi
5. Acceptance testing for production use and production certificate
Production use of interfaces requires software acceptance testing. Software acceptance testing is performed as a self-service in the API portal.
- The acceptance testing procedure is different from the actual testing of the integration functionality. Acceptance testing is performed once the software has been fully developed and tested.
- You will need a production certificate from the Certificate service.
- The API key is provided in the Vero-SoftwareKey header.
- You can find the addresses for acceptance testing on the Vero API Portal (URL Integration verification)
- Instructions for acceptance testing: Software registration and acceptance procedure - vero.fi
6. Production use of interfaces
For the production use of interfaces, the user must perform and observe the following.
- The application is registered in the API portal and the acceptance testing has been completed.
- The user of the interfaces has retrieved a production certificate from the Certificate service.
- The software must use the API key in the Vero-SoftwareKey header.
- The production addresses of the interfaces can be found in the Vero API Portal (URL Production)
- Instructions for production use: Vero API - Certificates for the production environment - vero.fi