Getting Started with OviPro API

Just follow these simple steps and you will be on your way.

1. Identify your integration scenario

– Use Marketing API to fetch published realties or
– Integrate with WordPress plugin (to be published)

Contact technical support for Etuovi.com

Contact technical support for Vuokraovi.com

developer
developer-site

2. Before you begin development

Before you can start using OviPro API, your organization needs to have a contract with OviPro or with Etuovi.com and/or Vuokraovi.com. OviPro APIs are provided with a fair use policy.

  • Get familiar with OviPro API
    Go through the OviPro API and the examples found in the API Documentation to see which one will best fit your use cases and integration scenarios.
  • Get API account
    Contact OviPro customer support to get the API keys for your organization. Verify that you can access the environment and make the first API request.
  • Create your integration and test the solution
    Create the integration by calling OviPro API in your preferred programming language. Test the solution with OviPro API.
  • For large integrations with separate environments:
    Once ready for production, contact OviPro customer support
    After testing your solution, Contact OviPro customer support to activate the production use.

3. Go-live checklist

  • You need to get at minimum one API account with credentials.
    This user is needed for the API client to authenticate the API usage.
  • Each API request to OviPro API requires a valid JWT token.
  • Store your API credentials in a secure place
  • Verify that all the expected and unexpected errors are properly handled.
  • You can find the API error responses for each endpoint from the API Reference.
  • Identify and test not only the sunny day scenarios but also the rainy day scenarios with edge cases.
  • When building the integration, review the logging especially for the error situations.
  • Make sure that your create a unique Request-ID for each request and also log this identifier as part of your solution. The Request-ID helps to troubleshoot the solution in case of error situations.
  • Design the data flow with OviPro API so that the API requests are reasonable: just enough details with good enough frequency.

OviPro

Contact info:
developer[at]ovipro.fi

Contact

Data Privacy

© Alma Media Oyj