Setting Up API Access: A Quick Guide

Read the step-by-step guide below or check out the video walkthrough. 

Overview

The Turris API allows you to:

• Automate agency creation and management
• Pull data from existing agencies
• Integrate with your internal systems
• Build custom workflows and automations

Step-by-Step Setup Process

Step 1: Access API Settings

1. Navigate to Settings in your dashboard
2. Click on API
3. You'll see the API management interface

Step 2: Add an API User

1. Click Add User
2. Enter the developer's information
3. Assign appropriate permissions
4. The developer receives an invitation to access the platform
5. They can manage a set of API keys

Step 3: API Key Management

Once a user has API access:

• They can generate their own API keys
• Keys are accessible from the API tab
• Multiple keys can be created for different purposes
• Keys can be revoked if needed

Sandbox Environment

Requesting a Sandbox

Turris offers sandbox instances for testing:

• Pre-populated with fake products
• Includes sample agency data
• Safe environment for development
• No impact on production data

To request a sandbox:

1. Contact Turris support
2. Specify your testing needs
3. Receive sandbox credentials
4. Begin development without risk

Sandbox Benefits

• Test agency creation workflows
• Practice data retrieval
• Develop integrations safely
• Validate API calls before production

API Documentation

Accessing Documentation

• Full API documentation is available upon request
• Contains all available endpoints
• Includes example requests and responses
• Updated regularly with new features

What's Included

• Authentication methods
• Endpoint descriptions
• Request/response formats
• Error handling guidelines
• Rate limiting information
• Best practices

Common Use Cases

The Turris API supports various integrations:

Agency Management:

• Automated agency onboarding
• Bulk agency updates
• License verification
• Compliance checking

Data Synchronization:

• Pull agency information
• Export compliance data
• Sync with CRM systems
• Update internal databases

Workflow Automation:

• Trigger onboarding from web forms
• Automate document collection
• Schedule compliance reports
• Integrate with existing tools

API Development Cycle

Recommended Approach

1. Start with Sandbox: Test all workflows in sandbox first
2. Review Documentation: Understand available endpoints
3. Build Integration: Develop using sandbox credentials
4. Test Thoroughly: Validate all API calls
5. Move to Production: Switch to production API keys

Ongoing Support

• New endpoints are constantly being added
• API functionality expands based on user feedback
• Custom use cases are welcomed
• Regular updates enhance capabilities

Requesting New Features

Turris actively develops new API capabilities:

• Share your use cases with support
• Suggest new endpoints
• Request specific functionality
• Influence the API roadmap

Your feedback directly shapes API development priorities.

Next Steps

1. Determine who needs API access
2. Add users or invite developers
3. Request sandbox access if needed
4. Review API documentation
5. Begin building your integration

The API opens up extensive automation and integration possibilities for your insurance operations.

As always, if you have any questions or something doesn't quite make sense, please reach out to us on our support channels.