Use API keys

After an API secret has been created for a user, it can be used to securely connect to various services within the application. For information on adding API Secrets for authentication, see the API Secrets section of the Define users article.

This section outlines the different ways users can apply API secrets, including:

Import data with web connector (Odata)

To use an API Secret with the OData Web Connector:

  1. Navigate to Import Of Data > Import Data File Structures.

  2. Select or add a new Odata file structure.

  3. In theFile type field, select Web Connector (Odata).

  4. Click the Columns tab and then, select the odata connector API Secret.

  5. Optionally, test the connection.

  6. Click .

  7. Next, proceed to use the API secret to schedule an import job, to run the web service.

Schedule web service import job

  1. Navigate to Administration > Schedules.

  2. Click the Web Service tab.

  3. In the File structure field, select the web service file structure.

  4. Schedule a job to run the web service. For details on running a web service job, refer to Web service section of the Create job schedules article.

Use API Secret for Prophix FC imports

Administrators must first configure API secret authentication for FC imports before imports can be executed

Configure API secret authentication for FC imports

  1. Navigate to Administration > System Configuration.

  2. Click the Global parameters tab.

  3. Under Prophix Financial Consolidation import: OData Configuration section, enter the OData API Secret.

  4. Save your settings and then, proceed to execute the import job.

Execute import job

  1. Navigate to Transfers Of Structures > Import From Prophix Financial Consolidation.

  2. Select the import options (insert only , update only, etc,) , the period, and structures to import from FC.

  3. For Odata Connector, select API Secret.

  4. Click to initiate the import.
    For details on importing structures from FC, refer to Import structures from Prophix Financial Consolidation.

 

Related Topics Link IconSee also