Getting access and support

Who to contact

• To connect a system, to ask for a test organization, or for keys: write to info@evorest.ch.
• For a deposit that is stuck, a missing document, or a question about an existing integration: write to support@evorest.ch and name the organization and the externalContractId.

Never send an API key or a password by email in clear text. Evorest tells you how to hand over secrets when you ask.

Steps to go live

1. Ask for a test organization. Tell Evorest the name of your property-management organization, which system you integrate (see Overview), and the email address of the property manager who should be registered on the test environment. Evorest creates the organization on test.
2. Receive the setup. Evorest sends you, for the test environment:
   • the external organization id (x-external-org-id) for opening deposits,
   • the API key for opening deposits,
   • for contract status, the Evorest organization id (x-org-id) and its own API key.
3. Build and test. Open test deposits against https://be-api.test.admin.evorest.ch. Check them in the test property-manager app at https://www.test.pm-app.evorest.ch.
4. Agree the callbacks. If your system receives documents or status changes, give Evorest the HTTPS base URL, the path for each document type, and the credentials Evorest must send (see Authentication). Then ask Evorest for sample callbacks on test.
5. Go live. Evorest creates the production organization and sends production keys. The production keys are separate from the test keys.

What partners cannot do through the API

There is no API call to withdraw or close a deposit.

• Withdraw. The property manager withdraws a deposit in the property-manager app. That is possible until the tenant has paid in, and only while the account has a zero balance. The deposit then has the state withdrawn in contract status, and Flatfox is told with aborted. You may open a deposit with the same externalContractId again afterwards.
• Close and pay out. The property manager starts the closing in the property-manager app, and the tenant signs it. See the state closing in contract status.
• Correct a deposit that was sent. The property manager edits it in the property-manager app. Sending the same externalContractId again to the webhook does not change it: the answer is skipped.

Ask your customers’ property managers to use the app for these steps.