Prefect Credentials Deployment Utilization

Running The Deployment

Input Json Format

Generic Format

The input format is in the form of two key/value pairs. The two keys are "payload" and "function"payload ➝ the payload described in the specific function descriptions belowfunction ➝ the name of one of the functions below

{
   "payload":"payload here",
   "function":"function name here"
}

modify_customer_creds_obj Format

This will be generic input for the modify_customer_creds_obj function. The values per API will be included in the bottom section "Specific API Inputs"The purpose of this function is to add customer credentials, add a new customer, and add an additional key for an existing API for a customer. (example of this would be a customer who has two whatconverts accounts and needs data extraction for both)

Understanding the Keys

customer_num ➝ A given customer number which is a customers unique identifierapi_name ➝ The name of the APIsecret_values ➝ This will be a nested json object that has all of the unique API values that are API specfic.additional_customer_key ➝ This is a boolean value. If set to True that means the customer already has a key for an API and wants to add another one like the whatconverts example above. If set to False it will just set the initial API credential inputs.

{
   "payload":{
      "customer_num":"F#",
      "api_name":"api name",
      "secret_values":{
         "key1":"value1",
         "key2":"value2"
      },
      "additional_customer_key":"boolean True or False"
   },
   "function":"modify_customer_creds_obj"
}

remove_customer_from_customer_creds_obj Format

This will be the generic input for the remove_customer_from_customer_creds_obj. Just based off the name it is used to remove a customer from the customer credentials object.

{
   "payload":"F#",
   "function":"remove_customer_from_customer_creds_obj"
}

Specific API Inputs

This will be a section dedicated to each particular API. It is meant to help expedite the process of adding customer credentials.

whatconverts

{
   "payload":{
      "customer_num":"F#",
      "api_name":"whatconverts",
      "secret_values":{
         "client_id":"id_value",
         "client_secret":"secret_value"
      },
      "additional_customer_key":"boolean True or False"
   },
   "function":"modify_customer_creds_obj"
}

catapult

{
   "payload":{
      "customer_num":"F#",
      "api_name":"catapult",
      "secret_values":{
         "bearer_token":"Bearer Token"
      },
      "additional_customer_key":"boolean True or False"
   },
   "function":"modify_customer_creds_obj"
}