Repository files navigation

ThePlug API Integration Package provides an intuitive and secureinterface to interact with the Plug API. It enables developers to storeuser credentials securely, fetch data using custom SQL queries, andmanage authentication tokens automatically.

Note: To access the Plug API, you must have valid credentials(username and password) provided by the API administrators.

Note: Plug uses Microsoft SQL as its database system, so SQLqueries must adhere to Microsoft SQL Server syntax (e.g.,SELECT TOP 1 instead ofLIMIT).

You can install the development version of the package directly fromGitHub:

# Install devtools if not already installedinstall.packages("devtools")# Install the packagedevtools::install_github("StrategicProjects/plug")

• Secure Credential Storage: Safely store and retrieve usercredentials with keyring.
• Token Management: Automatically handle API token generation andexpiration.
• Query Execution: Execute custom SQL queries securely using thePlug API.
• Data Download: Retrieve all data from specific tables with ease.

Before using the package, you need to store your Plug API credentialssecurely:

# Store your username and passwordplug_store_credentials("your_username","your_password")

The package automatically fetches and caches an authentication token. Ifyou need to retrieve it manually, use:

# Fetch a valid tokentoken<- plug_get_valid_token()

You can list stored credentials and tokens:

# List credentialscredentials<- plug_list_credentials()print(credentials)# List tokenstokens<- plug_list_tokens()print(tokens)

ou can execute custom SQL queries on the Plug API:

# Example: Execute a querydata<- plug_execute_query(sql_template="SELECT * FROM Contratos_VIEW LIMIT 1")

# Example: Download All Data from a Tabledata<- plug_download_base(base_name="Contratos_VIEW")print(data)

This package is under active development. Contributions are welcome! Ifyou encounter any issues, please open an issue on GitHub.

This package is licensed under the MIT License.