Executing Data Extraction APIs

After creating the data extraction API pipeline using the API Forge widget, you can use the API to extract the data.

Before working with APIs, verify that you have the following:

• Access to FCCM Cloud service.
• Appropriate user privileges to access the services.
• Technical and functional knowledge to understand and execute the REST APIs and configuration knowledge.
• Knowledge of REST concepts, JSON, browser-based REST client.
• Knowledge of an interactive and automatic tool for verifying the APIs such as Postman.

Create one or more data extraction API pipelines using the API Forge widget

After creating a data extraction API pipeline using the API Forge widget, you can use the API to extract the data.

1. Generate the Access Token by following the steps found in Authentication.
2. Open Postman or another relevant tool.
3. Configure your authorization.
   1. Copy the Access token you generated above.
   2. Go to the Authorization tab and select the Type as Bearer Token (Access token).
   3. Replace the token with the Access token you generated above.
4. Provide the sample input payload generated by your Data Extraction API pipeline.
   1. Copy the sample input payload generated by your Data Extraction API pipeline.
   2. Go to the Request Body tab and paste the sample input payload.
5. Send a request using the GET method by replacing the Post URL with the Generated URI from your Data Extraction API pipeline.

   Note:

   A unique URI will be generated for each APIForge widget in the pipeline.
6. Trigger the API request. You can change the parameters from the input payload at any time.
   The extracted records display in the Response Body.

   Note:

   By default, the number of records extracted is limited to 500. To extract more records, use the Offset parameter to extract records 501-1000, 10001-1500, and so on.