© Adviser Technologies Limited t/as Adviser.ai – Privacy Policy
Step 1: Accessing the correct information
To access the correct information, follow these steps:
1. Obtain the API Process Document
Where to find: Typically, this document is available in the company’s internal documentation , a shared drive, or directly from the API development team.
Details required: This document defines when you should be calling the API for the appropriate products and campaigns. It is essential to keep this information up to date for the API trigger points.
The Project Owner has access to the API Process document, If you’re unable to access please submit a ticket to https://adviser.ai/help/urgentrequest
2. Collect Company IDs
Where to find: Company IDs are typically part of the API Process Document, or given directly from the API development team.
Details required: These IDs uniquely identify each company within our system, necessary for making API calls related to specific products.
3. Gather Data Category IDs
Where to find: We categorize products using a Data Category ID (DCID) as the below table, you typically follow a structured approach that aligns each product with a specific set of fields or attributes relevant to that category. This system helps standardize data management and API interactions by ensuring consistent field usage and easier identification of product types.
Details required: These IDs categorize products, essential for ensuring the correct data fields are used during API interactions.
Product Category | Data Category ID |
Life Insurance | 1 |
Income Protection | 1 |
Retention | 2 |
Cover Review | 3 |
Policy Check | 4 |
Relationship | 5 |
4. Email and Password for Campaign API
Where to find: These credentials are generally provided by the project owner or the team responsible for managing API access. They may also be stored securely in a password manager or another secure location.
Details required: Credentials typically consist of an email and password combination that grants access to the API, and they are required for authentication purposes.
By following these steps, you should have all the necessary information to access and utilize the campaign API effectively. If any of these resources are missing or inaccessible, contacting the appropriate department or team within your organization is advisable or submit a ticket to https://adviser.ai/help/urgentrequest