Preparing for API activation

Perform the following to prepare for API Application Programming Interface (API) is the developer interface for the platform. Use the API to develop your own applications. activation.

1. Contact your Customer Success Manager to have a contract or Statement of Work put in place before proceeding.
2. Provide the following information to your Customer Success Manager.
   • An API Administrator name and email address. This is the person who will receive the client ID Used in the API. A public identifier for apps which should not be guessable./unique identifier email as well as the client secret Used in the API. A secret known only to the application and the authorization server. It is essential the application’s own password. retrieval email. Diligent can only send these emails to a single email address. Diligent cannot cc anyone.
   • A list of IP addresses or CIDR IP range(s) that will be used to connect to Third-Party Manager API. Include the IP of the workstation that the API Administrator will use to retrieve the client secret. All IP addresses provided must be internet-facing (public IP address). They cannot be private/internal IP addresses. See the next section for details.

    

Criteria for IP addresses

Ensure your IP address meets the following criteria. If you receive an "Invalid IP address" message when connecting, your IP address probably violates one or more criteria.

• The IP address is a static IP address that does not change.

• The IP address must be internet-facing (a public IP address). For example, if you work from home, the IP address is the one your Internet Service Provider (ISP) gives to your router.
• The IP address is not a private/internal IP address (such as 10.x.x.x).
• You are not connecting via a VPN then sending the IP from the VPN.
• You are not using an IPV6 IP address. Generally, you will need an IPV4 address. To check your IP address:
  1. Open a web browser.
  2. In the search bar, type in What's my IP? then click on a link to display your IP address.
  3. You will see an IPV 4 and IPV6. Use IPV4. You cannot use IPV6.

If you work in an office, your IT Department may be able to assign you a static IP address or a DHCP server MAC address.