Get an integration by its ID | Solvimon

curl https://test.api.solvimon.com/v1/integrations/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "reference": "intg-202406",
  "name": "Stripe Payment Gateway",
  "description": "Integration with Stripe for payment processing",
  "type": "PAYMENT_GATEWAY",
  "linked_resources_configurations": [
    {
      "resource_type": "order",
      "link_details": [
        {
          "base_url": "https://acme.ordersystem.com/orders",
          "custom_field_reference": "order_id"
        }
      ]
    }
  ],
  "object_type": "integration",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "status": "DRAFT",
  "message": "Pending approval",
  "authentication": {
    "api_key": {
      "header": "Authorization",
      "value": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"
    },
    "client_credentials": {
      "client_id": "stripe-client-id-123",
      "client_secret": "stripe-client-secret-456"
    },
    "username_password": {
      "username": "stripe_user",
      "password": "securePassword123!"
    }
  },
  "payment_gateway": {
    "variant": "ADYEN",
    "adyen": {
      "company_account": "AcmeCorpAccount",
      "environment": "LIVE",
      "live_prefix": "live_",
      "merchant_accounts": [
        "AcmeMerchant1",
        "AcmeMerchant2"
      ],
      "public_key": "pk_live_51H8xY2Lz",
      "signing_secret": "s3cr3tS1gn1ngK3y"
    },
    "stripe": {
      "public_key": "pk_test_TYooMQauvdEDq54NiTphI7jx",
      "signing_secret": "whsec_test_secret_123456"
    }
  },
  "e_invoicing": {
    "mandates": [
      {
        "name": "EU VAT Compliance",
        "country": "DE",
        "mappings": [
          {
            "target": "invoice_number",
            "source": "order_id",
            "description": "Map order ID to invoice number"
          }
        ],
        "condition_groups": [
          {
            "conditions": [
              {
                "field": "customer_country",
                "comparator_type": "EQUALS",
                "value": "DE"
              }
            ]
          }
        ],
        "supported_file_formats": [
          {
            "type": "XML",
            "description": "Standard XML format for e-invoices"
          }
        ]
      }
    ],
    "processor": "AVALARA"
  },
  "data_export": {
    "variant": "S3",
    "s3": {
      "bucket_name": "acme-data-exports",
      "bucket_path": "exports/integrations/",
      "bucket_region": "us-west-2"
    },
    "bigquery": {
      "project_id": "acme-bigquery-project",
      "dataset_id": "integration_data",
      "dataset_location": "US",
      "gcs_bucket_name": "acme-gcs-bucket",
      "gcs_hmac_key_access_id": "GOOG1E2XAMPLE",
      "gcs_hmac_key_secret": "hmacSecretKeyExample123"
    },
    "gcs": {
      "bucket_region": "us-central1",
      "bucket_name": "acme-gcs-exports",
      "bucket_path": "integrations/",
      "flattening": true
    },
    "snowflake": {
      "host": "acme.snowflakecomputing.com",
      "role": "DATA_ENGINEER",
      "warehouse": "COMPUTE_WH",
      "database": "ACME_DB",
      "schema": "INTEGRATIONS"
    }
  },
  "tax_calculation": {
    "billing_entity_id": "entity-7890",
    "variant": "AVATAX",
    "ava_tax": {
      "company_code": "ACME_CORP"
    },
    "custom_tax_codes": [
      {
        "field": "INVOICE_COMMITMENT",
        "value": "STANDARD"
      }
    ],
    "enable_tax_filing": true
  },
  "email_provider": {
    "variant": "SYSTEM",
    "mailgun": {
      "domain": "mg.acme.com",
      "region": "US",
      "plan": "premium"
    },
    "delivery_window": {
      "type": "DAY",
      "value": 1
    },
    "use_localized_templates": true
  }
}

Requires the INTEGRATION.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

referencestringformat: "^\S+$"0-256 characters

A custom reference assigned to the integration.

namestringformat: "^.*$"0-256 characters

A custom name assigned to the integration.

descriptionstringformat: "^.*$"0-256 characters

typeenum

The type of integration.

Allowed values:

linked_resources_configurationslist of objects

Details from the resources configurations from Solvimon linked to external integration system

object_typestring or nullRead-only

idstring or nullRead-only

statusenum or null

The status of the integration.

messagestring or nullRead-only

The message associated with the status of the integration.

authenticationobject

The authentication information used for the integration

payment_gatewayobject

e_invoicingobject

Integration to do eInvoicing

data_exportobject

tax_calculationobject

Integration to calculate tax

email_providerobject

Email provider integration settings. Applicable when the integration type is EMAIL_PROVIDER.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors