Add custom-api Ocean integration

[yarden-port]

trafficstars

User description

Description

What -

Why -

How -

Type of change

Please leave one option from the following and delete the rest:

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] New Integration (non-breaking change which adds a new integration)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Non-breaking change (fix of existing functionality that will not change current behavior)
• [ ] Documentation (added/updated documentation)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

• [ ] Integration able to create all default resources from scratch
• [ ] Resync finishes successfully
• [ ] Resync able to create entities
• [ ] Resync able to update entities
• [ ] Resync able to detect and delete entities
• [ ] Scheduled resync able to abort existing resync and start a new one
• [ ] Tested with at least 2 integrations from scratch
• [ ] Tested with Kafka and Polling event listeners
• [ ] Tested deletion of entities that don't pass the selector

Integration testing checklist

• [ ] Integration able to create all default resources from scratch
• [ ] Resync able to create entities
• [ ] Resync able to update entities
• [ ] Resync able to detect and delete entities
• [ ] Resync finishes successfully
• [ ] If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
• [ ] If resource kind is updated, run the integration with the example data and check if the expected result is achieved
• [ ] If new resource kind is added or updated, validate that live-events for that resource are working as expected
• [ ] Docs PR link here

Preflight checklist

• [ ] Handled rate limiting
• [ ] Handled pagination
• [ ] Implemented the code in async
• [ ] Support Multi account

Screenshots

Include screenshots from your environment showing how the resources of the integration will look.

API Documentation

Provide links to the API documentation used for this integration.

---

PR Type

New Integration, Documentation, Tests

---

Description

• Added a new Ocean integration for custom API ingestion.

  • Fetches data from a configured API endpoint.
  • Maps and transforms data into Port entities.
  • Supports API authentication with optional Bearer token.

• Defined configuration, blueprints, and mapping rules for the integration.

• Included documentation for setup, usage, and contribution guidelines.

• Added basic test and development environment setup.

---

Changes walkthrough 📝

	Relevant files
Enhancement	2 files debug.py Add debug entry point for integration                                        +4/-0      main.py Implement API data ingestion logic                                              +22/-0
Configuration changes	8 files setup.py Define setup configuration for custom API integration        +13/-0    .env.example Provide example environment variables for integration        +6/-0      blueprints.json Define blueprint schema for API items                                        +26/-0    port-app-config.yml Add mapping configuration for API data                                      +17/-0    spec.yaml Specify integration type and configurations                            +20/-0    poetry.toml Configure poetry virtual environment settings                        +3/-0      pyproject.toml Define project dependencies and tooling configurations      +113/-0  sonar-project.properties Add SonarQube project configuration                                            +2/-0
Tests	1 files test_sample.py Add placeholder test for integration                                          +2/-0
Documentation	3 files CHANGELOG.md Add changelog for custom API integration                                  +8/-0      CONTRIBUTING.md Add contribution guidelines for integration                            +7/-0      README.md Add README with setup and usage instructions                          +26/-0
Miscellaneous	1 files Makefile Add Makefile for integration infrastructure                            +1/-0
Additional files	1 files __init__.py [link]

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.