Frequently Asked Questions (FAQs)
This FAQ addresses common questions users and developers may have when working with the Fiscus SDK. It covers everything from installation to advanced functionality and best practices. If your question isn't answered here, please refer to the Documentation or contact support@fiscusflows.com.
General Questions
What is the Fiscus SDK?
Fiscus SDK is a platform that enables seamless integration of AI agents and language models with any API or service. It automates API management, workflow orchestration, and role-based access control (RBAC), simplifying the process of building intelligent applications.
What can I do with the Fiscus SDK?
With the Fiscus SDK, you can:
- Integrate any API with AI agents and models.
- Manage authentication, token management, and retries automatically.
- Orchestrate workflows across multiple APIs.
- Handle users, connectors, and roles with advanced RBAC features.
- Receive dynamic responses in text and JSON formats.
Installation and Setup
How do I install the Fiscus SDK?
You can install the Fiscus SDK using pip. Follow the detailed instructions provided in the Installation and Setup section of our documentation.
What are the system requirements for using the Fiscus SDK?
The Fiscus SDK requires Python 3.8 or higher. It can be used in cloud environments such as AWS, GCP, or Azure, and it requires internet access for API interactions.
How do I set up my Fiscus API key?
You will receive an API key when you register on the Fiscus platform. Use this key to initialize the SDK in your application.
What do I need to configure after installation?
After installation, you need to:
- Configure your FiscusClient instance with your API key.
- Set up any necessary connectors for the APIs you will use.
- Authenticate your connectors as needed.
Refer to the Getting Started section for more information on configuration.
API Calls and Operations
How do I execute an API call using Fiscus?
To execute an API call, you need to:
- Initialize your FiscusClient instance.
- Define the connector and operation (such as sending an email or creating a record).
- Pass in the required parameters for the operation.
Details can be found in the Executing API Calls section.
Can I orchestrate multiple API calls with Fiscus?
Yes, Fiscus allows you to orchestrate complex workflows with multiple API calls. You can chain tasks, execute them in sequence, and handle errors with retry mechanisms.
Check out the Task-Based Orchestration section for more details.
How does Fiscus handle asynchronous API calls?
Fiscus provides built-in support for asynchronous execution. You can run multiple API calls concurrently to improve performance, especially in scenarios that involve high-latency APIs.
Refer to the Asynchronous Execution section to learn more.
What is the difference between stateless and stateful backends in Fiscus?
- Stateless Backend: The user state is managed externally and passed explicitly with each request.
- Stateful Backend: The SDK maintains user state internally, making it easier to manage session-based workflows.
For more information, check out the Stateful vs Stateless Backends section.
Connector Management
How do I add and manage connectors?
Connectors are added by specifying the service or API you want to integrate with (e.g., gmail, Salesforce). Once added, you can authenticate the connector and manage its operations.
Refer to the Adding and Managing Connectors section for details.
How does Fiscus handle authentication for different connectors?
Fiscus supports various authentication methods, including API keys and OAuth flows. You can set up an authentication callback to handle multiple connectors.
See the Authentication and Tokens section for a complete guide on handling authentication.
Can I manage persistent connections?
Yes, Fiscus supports persistent connections, such as WebSockets, for real-time data streaming. You can manage these connections directly from the SDK.
Details are available in the Persistent Connections section.
User Management and RBAC
How do I manage users in Fiscus?
Users can be created and managed within the SDK. You can associate users with different connectors, authenticate them, and apply custom roles and policies.
For more information, visit the Managing Users section.
What is Role-Based Access Control (RBAC) in Fiscus?
Fiscus offers an advanced RBAC system that allows you to define roles and policies to manage user permissions. You can assign roles to users and restrict access to specific connectors and operations based on those roles.
See the Role-Based Access Control (RBAC) section for more information.
Can I manage multiple users and their sessions?
Yes, Fiscus provides full support for managing multiple users, each with their own set of connectors, roles, and preferences. This is useful for multi-tenant applications or scenarios where users need different permissions.
Visit the Managing Users in Multiple Scenarios section for detailed examples.
Security and Compliance
How does Fiscus ensure security?
Fiscus adheres to industry-standard security practices, including:
- Encryption for data in transit and at rest.
- Role-based access control (RBAC) to limit permissions.
- Secure API key and token management.
- Audit trails for tracking operations.
For a full overview, see our Security Guide.
What compliance standards does Fiscus follow?
Fiscus aligns with key security and data protection standards, including:
- OWASP (Top Ten)
- NIST (Cybersecurity Framework)
- GDPR and CCPA for data privacy.
- SOC 1 and SOC 2 for auditing and reporting.
More details are available in the Security Guide.
How do I manage API keys and secrets securely?
Fiscus recommends storing API keys and secrets in secure environments, such as AWS Secrets Manager or environment variables. API keys should not be hardcoded in your codebase.
Refer to the Security Best Practices for additional recommendations.
Callbacks and Customization
What are callbacks in Fiscus?
Callbacks in Fiscus are functions you can set up to handle events such as success, errors, authentication, and logging. This allows you to customize the behavior of your API calls and workflows.
See the Callbacks and Hooks section for more details.
Can I customize workflows in Fiscus?
Yes, you can customize both pre- and post-execution hooks, as well as inject custom logic into workflows. This is particularly useful for implementing specific business logic.
Refer to the Advanced Workflow Customization section for more information.
How do I handle errors and retries in Fiscus?
Fiscus offers built-in error handling and retry mechanisms. You can define how many retries should be attempted and set custom backoff strategies for API calls.
Check out the Handling Errors and Retries section for best practices.
Response Handling
How does Fiscus handle API responses?
Fiscus supports flexible response formats, allowing you to choose between text-based responses with dynamic data or full JSON responses, depending on your needs.
For more information, visit the Handling Responses section.
Can I process streaming data with Fiscus?
Yes, Fiscus supports streaming data through persistent connections (such as WebSockets). You can set up callbacks to process streaming data in real-time.
Refer to the Streaming Callbacks section for more details.
Advanced Usage
Can I integrate Fiscus with AI agents and frameworks?
Yes, Fiscus integrates seamlessly with popular AI frameworks such as LangChain and Crew, as well as language models like OpenAI. You can use Fiscus to dynamically orchestrate API calls based on AI-driven workflows.
For more information, visit the Integrating with AI Agents and Language Models section.
How do I enable logging and audit trails?
Fiscus provides extensive logging and audit trails for tracking API calls and workflow execution. You can configure logging levels and choose whether to log to a file or the console.
Refer to the Audit Logging section for more information.
How do I troubleshoot common issues in Fiscus?
For common issues, check the logs and audit trails for detailed information on API calls and operations. Additionally, make sure that connectors are authenticated correctly and that permissions (RBAC) are set up as needed.
For further assistance, contact support@fiscusflows.com.