This portal will provide information on how to use the Connect API to its most efficient capacity.
This documentation contains the following corresponding sections of the sidebar navigation.
These are not clickable links on this page but can be accessed through the sidebar. The resources include:
This will include information on the following:
- Structure of the Documentation Portal and how to Navigate it
- Authentication with the API
- Rate Limiting
- HTTP Methods supported by the API
- Error Codes returned by the API
- Security Best Practices
- Versioning Strategy and Changelog Structure
- Changelog Notification via Widget
- Feedback - The new portal allows you to leave feedback on any specific page, and also to highlight any suspected code queries
- This will provide basic information on how to access any of the collections in either YAML or JSON to start making calls to the API
- Authenticating with the API
- This provides two methods of acquiring the API Specifications
- The full Connect API and all of its associated products
- Individual modualised products of the API for a more directed API Specification
A dedicated Resource Links page is available in the sidebar, providing quick access to key external tools and reference materials including the front-end demo site, help articles, data dictionaries, data availability, feature availability per country, and Connect report templates.
You can now get instant help with general questions or guidance on using the portal by clicking the search option in the top right corner and selecting Search with AI. The AI tool uses all available documentation resources to assist you as much as possible.