Summa icon

Summa

Consume Summa API (v.0.1.7)
Join our community

Actions182

Overview

The "Sim Add" operation in the Summa node allows users to add new SIM card data into the Summa system via its API. This operation is useful for telecom operators or service providers who need to programmatically register SIM cards with detailed attributes such as IMSI strings, external identifiers, security credentials, and ISIM configurations.

Typical use cases include:

  • Bulk importing SIM card information from an external database.
  • Automating SIM provisioning workflows.
  • Integrating SIM management into broader telecom service orchestration.

For example, a user can provide either raw JSON data representing multiple SIMs or structured form inputs specifying IMSI lists and SIM security details, which the node then sends to the Summa backend to create the SIM records.

Properties

Name Meaning
Operator Name The name of the operator responsible for the SIMs being added.
Common Sim Security Name The common security profile name applied to the SIMs.
Send Json Boolean flag indicating whether to send raw JSON data (true) or structured form data (false).
Json Data Raw JSON input containing SIM data to be sent directly when Send Json is true.
Imsi List A collection of IMSI entries (when Send Json is false), each including:
- IMSI String
- Multiple External Identifiers (each with Id, Identifier string, Type, Trace Active flag)
- Default External Identifier
- Mobile Station Category
Sim SIM security and configuration details (when Send Json is false), including:
- ICC ID
- PUK code
- OPc value
- Ki key
- Gete UICCID
- ISIM configuration list (with ICC ID, IMS template, and IMPU configuration list detailing public identities, service profiles, and transparent data templates)

Output

The node outputs JSON data representing the response from the Summa API after attempting to add the SIM(s). This typically includes confirmation of created SIM records, any generated IDs, status messages, or error details if the operation failed.

If binary data were involved (not indicated here), it would represent files or attachments related to the SIM data, but this node focuses on JSON-based API responses.

Dependencies

  • Requires an API key credential for authenticating with the Summa backend API.
  • Uses an HTTP client internally to communicate with the Summa REST API.
  • The node depends on the Summa API version specified in the bundled source (version referenced dynamically).
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrectly formatted JSON in the Json Data property may lead to request errors.
    • Omitting required fields like Operator Name or Common Sim Security Name will result in validation errors.
    • Providing inconsistent or incomplete IMSI or SIM details when not using raw JSON can cause backend rejections.

  • Error Messages:

    • Authentication errors: Check that the API key credential is correctly configured and valid.
    • Validation errors: Review the input properties to ensure all required fields are filled and properly formatted.
    • Network or timeout errors: Verify network connectivity to the Summa API endpoint.

Links and References

Discussion