Producerflow API

For Producerflow clients seeking seamless API integration with their services

Trusted by insurance companies of all sizes to manage onboarding, licensing, appointments, and ensure compliance—all in one platform. This comprehensive API service provides gRPC and Connect endpoints for managing producer workflows and data flows, built with modern protocol buffer definitions and generating client libraries for multiple languages.

Table of Contents

• Producerflow API
  • Table of Contents
  • Quickstart
    • API Endpoints
    • API Token Generation
  • Installation & Usage
    • Using Protocol Buffer Files
    • Using Pre-Generated Clients
      • Go Client
      • TypeScript Client
  • Client Libraries
    • Generated Client Directories
    • Supported Languages
    • Navigation Guide
  • Build/Generation Instructions
    • Generating Official Clients
    • Prerequisites
    • Custom Generation for Other Languages
  • Glossary
  • Security
  • Deprecation Policy
  • Contact/Support
  • License
  • Versioning

Quickstart

⚠️ Notice
Pull requests are disabled for this repository. For support and questions, please contact our team directly.

API Endpoints

The Producerflow API is available at the following endpoints:

• Production: https://api.producerflow.com
• UAT (User Acceptance Testing): https://api.uat.producerflow.com

Use the production endpoint for live applications and the UAT endpoint for testing and development purposes.

API Token Generation

To get started with the Producerflow API, you'll need to generate an API token:

1. Log into your Producerflow account.
2. Navigate to API Keys in your account settings.
3. Generate a new API key with appropriate expiration date.
4. Securely store your API key for use in API requests.

For detailed API documentation and examples, visit our comprehensive API documentation.

Installation & Usage

Using Protocol Buffer Files

The raw .proto files are located in the producerflow/ directory and can be used to generate clients for any language supported by Protocol Buffers.

# Install buf and necessary plugins for your target language
# Then generate clients using the proto files
buf generate

Using Pre-Generated Clients

Go Client

go get github.com/producerflow/producerflowapi@latest

TypeScript Client

npm install @producerflow/producerflowapi

For detailed installation and usage instructions, see the respective client library documentation.

Client Libraries

Generated Client Directories

• Go Client Library - Complete Go implementation with gRPC and Connect support
• TypeScript Client Library - Full TypeScript/JavaScript client with type definitions
• Kotlin Client Library - Full Kotlin client with type definitions

Supported Languages

The monorepo currently provides official support for:

• Go (1.21+)
• TypeScript/JavaScript (Node.js 18+)
• Kotlin (1.9+)

For other languages, use the Protocol Buffer definitions in producerflow/ with the official Protocol Buffer compiler and language-specific plugins. Refer to the Buf documentation for comprehensive language support.

Navigation Guide

• API Definitions: Start with producerflow/producer/v1/producer.proto
• Go Integration: Use code in gen/go/ directory
• TypeScript Integration: Use code in gen/ts/ directory
• Kotlin Integration: Use code in gen/kotlin/ directory
• Documentation: Reference comprehensive documentation for detailed API guides

Build/Generation Instructions

Generating Official Clients

To regenerate the Go and TypeScript clients within the monorepo:

# From the repository root
buf generate

This command will:

1. Validate all Protocol Buffer definitions
2. Generate Go client code in gen/go/
3. Generate TypeScript client code in gen/ts/
4. Generate Kotlin client code in gen/kotlin/

Prerequisites

• Buf CLI installed
• Go 1.21+ (for Go generation)
• Node.js 18+ (for TypeScript generation)
• Java 17+ (for Kotlin generation)

Custom Generation for Other Languages

For languages not officially supported by this monorepo, refer to the Buf documentation for comprehensive code generation guides and plugin configurations.

Glossary

This section will be populated with domain-specific terms and definitions.

Security

For security concerns, vulnerability reporting, and our comprehensive security policies, please see our Security Policy.

For immediate security issues, contact: support@producerflow.com

Deprecation Policy

This API follows a structured deprecation approach to ensure backward compatibility and smooth transitions. For detailed information about our deprecation timelines, migration guides, and policy, see DEPRECATION.md.

Contact/Support

For technical support, integration assistance, or general inquiries:

Email: support@producerflow.com

Documentation: Visit our comprehensive documentation for detailed guides and examples.

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

Versioning

This project follows Semantic Versioning. See the CHANGELOG.md for release history and detailed version information.

---

© 2025 Producerflow. All rights reserved.