CustomerInsights

Repository to describe, develop, document, and test the CustomerInsights API(s)

Scope

• Service APIs for “CustomerInsights”
• The API provides the customer with the ability to:
  • Provides a risk index (a.k.a. Scoring) based on the individual's profile owned by a Telco Operator.
  • So far two scoring scales are defined within the current proposal (GaugeMetric, VeritasIndex).
• Describe, develop, document, and test the APIs
• Started: October 2024

Release Information

• Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release.

• The pre-release r1.1 - rc for the Customer Insights APIs Family is available.
  This is a release candidate version of the API. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

• The release r1.1 - rc is available in r1.1, and includes the following APIs:

• API name: Customer Insights - API Definition v0.1.0-rc.1 with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

• Other releases of this sub project are available in CustomerInsights Releases
• For changes see CHANGELOG.md

Contributing

• Meetings are held virtually
  • Schedule: Bi-Weekly on Thursdays at 14:00 UTC
  • Registration / Join
  • Minutes: Access [meeting minutes]
• Mailing List
  • Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-customerinsights.
  • A message to the community of this Sub Project can be sent using sp-customerinsights@lists.camaraproject.org.