Skip to main content

Authorization

Follow this guide to create a new FDA credential that will allow Nexla to authenticate to and exchange data with the FDA OpenFDA API.
fda_api_auth.png

FDA

Prerequisites​

Before creating an FDA credential, you need to obtain an API Key Value from the FDA OpenFDA API. The API Key Value is required to authenticate with the FDA OpenFDA API.

To obtain your API Key Value, you need to register for an API key from the FDA OpenFDA API. Once you have registered, you can generate an API key from the FDA OpenFDA API authentication page. The API Key Value is sent as the api_key query parameter for all API requests to the FDA OpenFDA API. For detailed information about API key setup and authentication, refer to the FDA OpenFDA API documentation.

Create an FDA Credential​

  • To create a new FDA credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – FDA

FDACred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Value​

  1. Enter your FDA API Key Value in the API Key Value field. This is the API key you obtained from the FDA OpenFDA API authentication page. The API Key Value is sent as the api_key query parameter for all API requests to the FDA OpenFDA API.

    Keep your API Key Value secure and do not share it publicly. The API Key Value provides access to the FDA OpenFDA API and should be treated as sensitive information. The API Key Value is sent as the api_key query parameter for all API requests to the FDA OpenFDA API. For detailed information about obtaining and managing API keys, see the FDA OpenFDA API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.