How to get API Servives?

[Genyus]

I was able to add the license key but still I'm not able to use the api service as given in the document.

http://localhost:30223/api/v1/



Also I was looking to install the API Services, but I could not see any Folder/Exe files related API Service in opendental installation. Please kindly guide me.

[justine]

I was able to add the license key but still I'm not able to use the api service as given in the document.

http://localhost:30223/api/v1/



Also I was looking to install the API Services, but I could not see any Folder/Exe files related API Service in opendental installation. Please kindly guide me.

Good morning Genyus,

Firstly, a few baseline questions.

Are you on version 22.2.16 or later?
Are you able to successfully send a GET request using your keys with the remote API?
Is the API enabled within Open Dental? (Setup -> Advanced Setup -> API -> Enabled checkbox)
What services are installed? (Tools -> Misc -> Service Manager)
Have you followed all the steps as found in the API Service section of the documentation? (https://www.opendental.com/site/apilocal.html)

Thanks!

[Genyus]

We were able to download the trial version 21-4-46 only. (TrialDownload-21-4-46.exe)

[justine]

We were able to download the trial version 21-4-46 only. (TrialDownload-21-4-46.exe)

Hello Genyus,

Please see the Installation documentation:
https://www.opendental.com/manual/installation.html

[Genyus]

Dear Support Team,

While trying to start API Services, I'm getting the error that "Time out has expired and the operation has not been completed". Please help me to start the api service? And let me know how to check the API with sample API Call.

[SLeon]

Good morning,

Here are some troubleshooting steps you can take for the API Service:

• Check the connection details in \OpenDental\OpenDentalAPIService\OpenDentalWebConfig.xml to ensure your database credentials are correct
• Uninstall the API Service, launch Open Dental as administrator, and reinstall the API Service
• View the API Service log files in \OpenDental\OpenDentalAPIService\Logger for specific error messages

As far as testing with a sample API call, you can use any of the same API requests you normally make to our Remote API endpoint url (https://api.opendental.com/api/v1/...) but instead to the API Service endpoint url (http://{PrivateIPAddress}:30223/api/v1/...). See API Modes - Local and Service for more information specific to the API Service.

[Genyus]

Good Morning!!!

Thanks @SLeon for the response.

I have tried to check the logger and I see the error "Failure to initialize database. Connection name not found: DentalOffice". Our database name is "demo" and below is the value in the OpenDentalWebConfig.XML file.

<DatabaseConnection>
<ComputerName>localhost</ComputerName>
<Database>demo</Database>
<User>root</User>
<Password>mypass</Password>
<MySQLPassHash>odv2e$ie1UhME2Vn1uJPzRmvhMTA==</MySQLPassHash>
<UserLow></UserLow>
<PasswordLow></PasswordLow>
<DatabaseType>MySql</DatabaseType>
</DatabaseConnection>

Can you let me know where should I look for this connection name "DentalOffice" and how to get over this issue?

[SLeon]

Good morning Genyus,

Your OpenDentalWebConfig file is missing a "Note" node. Open Dental will automatically make this file and install the API Service for customers who have the API enabled (Setup > Advanced Setup > API).

To manually fix this issue, paste in the <Note>DentalOffice</Note> node after the DatabaseType node. Your password should not be in plaintext. Move the hash string from the MySQLPassHash node to the Password node instead and delete the MySQLPassHash node.

[Genyus]

Hi @SLeon

Thank you for your response. That resolved the issue and API service is now working.


Thanks

[SLeon]

The API Service has been enhanced to show a Configuration Settings window when installing it through Open Dental. This will allow changes to the database connection details without having to manually edit the OpenDentalWebConfig.xml file.

Customers will see this new window starting in versions 22.2.42 and 22.3.13.