Register a Client Application
Before you can begin using the APIs, you must register an App. The App is used to uniquely identify the caller to an endpoint. After the App is registered, the App has an assigned Client ID and Client Secret. The Client ID is a public and unique identifier that will be used to identify the client application as an application. The Client Secret is a private identifier kept secret between the App and the API. The Client Secret is used to authenticate the App when it makes a request for an access token.
To Register an App:
- Log in to EBSCO Developer.
- Click on My Apps in the top navigation. This form is used by all EBSCO products, so some fields will not be needed.
- Click on the Add a new App button at the top of the page.
A form will appear.
- Enter the following information. This form is used for many EBSCO products. Therefore, there are some fields that are required that are not used by MedsAPI.
- App Name: Please choose a name which reflects your organization.
- Callback URL: This field is not used by MedsAPI. It may be left blank.
- Type of App: This field is not used by MedsAPI. It can be left as the default.
- Customer ID and Group ID: These are required for MedsAPI. Please use your valid IDs that you received from your EBSCO representative. Partners should consult the partner register app page for details.
- Does this App need to access user identities and/or details? This field is not used by MedsAPI. It can be left as the default.
- Product: Select MedsAPI to request that your App can use any MedsAPI product for which you have access. Do NOT select another product for this app.
- Click the Create App button. You are returned to the My Apps page and your new App is listed. Your new App will be Pending until your information has been reviewed and approved. You will receive an email once your App has been Approved.
- Log in to EBSCO Developer once you receive your App Approval email.
- Navigate to the My Apps page. The App status for your new App will show Approved.
- Click on the name of your application in the list. The Credentials section is displayed. Your application credentials, the Client ID and the Client Secret, are listed.
- Make note of the Client ID and Client Secret for the App. Please use the Client ID and the Client Secret when requesting an OAuth 2.0 token..