Documentation for Adding New API Integrations

[azamiftikhar1000]

I attempted to add a new API integration to Pica but encountered ID validation errors despite correctly configuring all database collections.

What I Did

1. Added a new connection definition with proper structure in connection-definitions collection
2. Created corresponding model definitions in connection-model-definitions collection
3. Set up connection record with proper references
4. Updated all fields to match the structure of working platforms like Shopify

Errors Encountered

All endpoints returned variations of: "Invalid ID: invalid Base64 length" or "Invalid ID prefix: cmd"

Questions

1. Documentation Request: Is there documentation on the proper process for adding new API integrations to Pica?

2. Integration Testing: Is there a recommended workflow or validation tool to ensure a new integration is properly configured?

3. Example: Could you provide a working example of adding a simple API integration from scratch?

[azamiftikhar1000]

Any update @paulkr @moekatib

[sagoez]

Hey @azamiftikhar1000 , the issue you’re encountering is related to the format of the ids you’re using. Easiest way to fix it is to create them using this module https://github.com/picahq/pica/tree/main/osentities/src/domain/id. After creating the ids properly your issues should be resolved.