Setup
To set up an OData endpoint that you can connect to, you will need to first request an API enabled EBMS Relay Key from Eagle Business Software.
This will allow access to your data securely from anywhere in the world. There is a $50/month fee that includes both the API enabled relay key and EBMS API support.
Note: if you have your own SSL certificate and domain name, you can set that up on your EBMS server using port 23200.
If you do go the route of using a direct connection instead of using the EBMS relay, you may need to work with your IT department to make sure that the API is not blocked by your firewall.
In this scenario, you should still follow points 5 and 6 below; your URL will be
https://[your domain]:23200/MyEBMS/[your ebms data id]/Odata/]
Once you have received that relay key from Eagle Business Software, follow these steps to configure your server:
- 1. Open the EBMS Server Manager on your EBMS server
- 2. Click Settings and then go to the Advanced tab
- 3. Enter the EBMS Relay Key into the field marked Relay key
- 4. Close settings to return to the main EBMS Server Manager screen
- 5. Find the company whose data you want to access and turn on Enable external services
- 6. When prompted, press Restart EBMS services. This may take a minute or so to take effect
Your OData endpoint should now be open! To verify that the endpoint is running, you'll need to note your EBMS serial number and the three-character ID of the data that you want to access.
Once you have that, enter this url into your browser:
https://ecc[your serial number].servicebus.windows.net/MyEBMS/[your ebms data id]/Odata/
This should display a list of entities that you have access to in an XML format. You do not need any credentials to view this metadata.