How to Use This Site
The Aven Hospitality Developer Portal enables you to access API documentation and try API operations.
Improvements are Underway #
The Developer Portal content is continuously evolving. As part of this ongoing improvement effort, content will be updated, reorganized, and occasionally moved or consolidated to improve clarity and usability. As a result, pages you previously referenced may appear in a different section or be combined with related content. If you cannot locate information where you last saw it, check the API’s Description tab or adjacent sections, where related guidance is most often consolidated.
Linkable Headings #
Linkable headings are one improvement that is underway. Linkable headings are followed by #, and they enable you to quickly copy a link to specific section of content on the page. You can right-click a linkable heading and select Copy Link to copy the URL. Alternatively, you can click a linkable heading and copy the URL from the browser's address bar.
Finding Content #
The best way to find an API to fit your needs is:
1. Go to the Product Catalog.
2. Select Show Filters.
3. Filter the content based on your needs.
4. Browse through the APIs that your filter displays.
SOAP APIs #
SOAP APIs generally show you a page of descriptive information and examples. If you sign in with the proper permissions, you can see a Resources tab with more detailed information and specifications. Under Guides, you can learn about the basics of our SOAP APIs.
REST APIs #
REST APIs generally show you a Description tab that covers details of how to use the API. REST APIs also include a Reference Documentation tab with an interactive specification so that you can try the API endpoints. Under Guides, you can learn about the basics of our REST APIs.
Release Notes #
Under Release Notes, you can find details of API updates for all of our recent releases.
Certifications #
Under Certifications, you can learn about our program for Partners. If you become a Partner, the Certifications area is where you will have access to more Partner-specific content.