DNAPI - Frequently Asked Questions

How to handle payments?

You don't. Payments are handled by third-parties. Creating a rental using DNAPI only logs said rental into the renter's calendar. It is then possible to pay from this calendar, at the renter's discretion.

What are the supported languages?

We currently support seven different languages. Please note however that some of the data returned by the API is filled out by the renters, and they don't always do the translation in every available language. The supported languages are: - German (code: de) - Dutch (code: nl) - English (code: en) - French (code: fr) - Italian (code: it) - Portuguese (code: pt) - Spanish (code: es)

How are boats described?

All our boats are described according to the OpenMarine schema. The data returned by the API doesn't match the schema one-to-one though.

What are the available company types, boat types, option types, etc.

Part of our database is semi-static. Which means it rarely changes and it reused in multiple places. That's for instance the case of boat types and subtypes. For more information about those types of data, you can check for reference the endpoints tagged "misc", also present under the "Miscellaneous data" label on the documentation menu.

Why does two different resources share the same boatId?

A resource is actually a boat and harbour pair. Which means that whenever a boat is available for rental on multiple harbours, it shows up as multiple resources, with the same boatId.

How come the same boat can be rentable in two different harbours at the same time?

Well, they actually can't. Each boat has a delay before rental. How that delay is configured is up to the individual renter, but in practice that delay can be used to move a boat from one harbour to the other. You can find that delay under the /resource/{resourceId}/availability endpoint.

One important thing to note is that this delay can vary between weekday and weekend day.

What about payment lines?

Payment lines are payment logs. Most of the time, they are added automatically whenever a payment is made from the DNPro. However, we still expose an API to edit payment lines. It is useful to handle payments being done outside of DNPro, such as cash payments.

When are emails sent?

No mail is sent directly from the API. Instead, some mails are sent from DNPro, and some are sent automatically. Details follow:

  • Client confirmation email. An email containing a summary of the upcoming rental. Can be sent manually from DNPro.

  • Client contract email. An email containing the rental contract. Can be sent manually from DNPro.

  • "Day before" email. Sent on the rental's eve. Contains a summary of the upcoming rental.

  • Email asking for review. Sent automatically after the rental.

  • Email thanking for review. Sent automatically after the client left a review.

What are administrative areas?

You may know them as regions, or departments. Wikipedia has a more extensive documentation on this subject.

What about the rental contract?

The rental contract is automatically generated on rental confirmation. It will automatically be sent to the client's email address later.

How to authenticate to the API?

API users are given a unique token to authenticate to the API. In order to do so, include the token with the 'Authorization' header, following this pattern: Authorization:Token <token>.