portier X Documentation

Integrations

Application Categories

GET
/api/v1/integrations/categories

Authorization

Authorization<token>

In: header

curl -X GET "https://api.portierx.com/api/v1/integrations/categories" \
  -H "Authorization: <token>"

{}

Application Available

GET
/api/v1/integrations/available

Authorization

Authorization<token>

In: header

curl -X GET "https://api.portierx.com/api/v1/integrations/available" \
  -H "Authorization: <token>"

{
  "msg": "Retrieved item list successfully",
  "data": [
    {
      "id": "019642f1-c864-78ca-88fc-c06843fff8e8",
      "name": "SalesForce",
      "slug": "salesforce",
      "application_id": "",
      "description": "Leading CRM platform",
      "logo_url": "/images/salesforce.png",
      "keywords": [
        "CRM",
        "Sales",
        "Cloud"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Contact Management",
            "content": "<h2>Comprehensive Contact Management</h2><p>Manage all your customer relationships in one place.</p>",
            "image_urls": [
              "/images/salesforce-contacts.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via REST API or Webhooks.</p>",
      "category_id": "019642f1-c855-73fa-adb5-c551d929b1be"
    },
    {
      "id": "019642f1-c864-78d2-bfc3-c2bbda216fb6",
      "name": "SimonsVoss",
      "slug": "simonsvoss",
      "application_id": "",
      "description": "Advanced digital locking systems",
      "logo_url": "/images/simonsvoss.png",
      "keywords": [
        "\"Access Control\"",
        "Security",
        "IoT"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Digital Locking",
            "content": "<h2>Digital Locking System</h2><p>State-of-the-art keyless entry system.</p>",
            "image_urls": [
              "/images/simonsvoss-lock.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via SimonsVoss API.</p>",
      "category_id": "019642f1-c855-7401-a65a-0f4541e1f1a4"
    },
    {
      "id": "019642f1-c864-78d7-8264-15d81669055a",
      "name": "Google Analytics",
      "slug": "google-analytics",
      "application_id": "",
      "description": "Comprehensive web analytics",
      "logo_url": "/images/ga.png",
      "keywords": [
        "Analytics",
        "Web",
        "Tracking"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Web Analytics",
            "content": "<h2>Advanced Analytics</h2><p>Track and analyze website traffic.</p>",
            "image_urls": [
              "/images/ga-dashboard.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via Google Analytics API.</p>",
      "category_id": "019642f1-c855-7405-a201-1b596d583ce7"
    },
    {
      "id": "019642f1-c864-78db-a771-2e36263abcc3",
      "name": "Slack",
      "slug": "slack",
      "application_id": "",
      "description": "Business communication platform",
      "logo_url": "/images/slack.png",
      "keywords": [
        "Chat",
        "Collaboration",
        "Notifications"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Instant Messaging",
            "content": "<h2>Real-time Communication</h2><p>Connect your team in real-time.</p>",
            "image_urls": [
              "/images/slack-chat.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via Slack API or Webhooks.</p>",
      "category_id": "019642f1-c855-7409-ad14-20a22ea2dc1b"
    }
  ],
  "meta": {
    "pagination": {}
  }
}

Application Available by ID

GET
/api/v1/integrations/available/{id}

Authorization

Authorization<token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.portierx.com/api/v1/integrations/available/<string>" \
  -H "Authorization: <token>"

{
  "msg": "Retrieved item list successfully",
  "data": [
    {
      "id": "019642f1-c864-78ca-88fc-c06843fff8e8",
      "name": "SalesForce",
      "slug": "salesforce",
      "application_id": "",
      "description": "Leading CRM platform",
      "logo_url": "/images/salesforce.png",
      "keywords": [
        "CRM",
        "Sales",
        "Cloud"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Contact Management",
            "content": "<h2>Comprehensive Contact Management</h2><p>Manage all your customer relationships in one place.</p>",
            "image_urls": [
              "/images/salesforce-contacts.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via REST API or Webhooks.</p>",
      "category_id": "019642f1-c855-73fa-adb5-c551d929b1be"
    },
    {
      "id": "019642f1-c864-78d2-bfc3-c2bbda216fb6",
      "name": "SimonsVoss",
      "slug": "simonsvoss",
      "application_id": "",
      "description": "Advanced digital locking systems",
      "logo_url": "/images/simonsvoss.png",
      "keywords": [
        "\"Access Control\"",
        "Security",
        "IoT"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Digital Locking",
            "content": "<h2>Digital Locking System</h2><p>State-of-the-art keyless entry system.</p>",
            "image_urls": [
              "/images/simonsvoss-lock.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via SimonsVoss API.</p>",
      "category_id": "019642f1-c855-7401-a65a-0f4541e1f1a4"
    },
    {
      "id": "019642f1-c864-78d7-8264-15d81669055a",
      "name": "Google Analytics",
      "slug": "google-analytics",
      "application_id": "",
      "description": "Comprehensive web analytics",
      "logo_url": "/images/ga.png",
      "keywords": [
        "Analytics",
        "Web",
        "Tracking"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Web Analytics",
            "content": "<h2>Advanced Analytics</h2><p>Track and analyze website traffic.</p>",
            "image_urls": [
              "/images/ga-dashboard.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via Google Analytics API.</p>",
      "category_id": "019642f1-c855-7405-a201-1b596d583ce7"
    },
    {
      "id": "019642f1-c864-78db-a771-2e36263abcc3",
      "name": "Slack",
      "slug": "slack",
      "application_id": "",
      "description": "Business communication platform",
      "logo_url": "/images/slack.png",
      "keywords": [
        "Chat",
        "Collaboration",
        "Notifications"
      ],
      "features": {
        "title": "Features",
        "features": [
          {
            "name": "Instant Messaging",
            "content": "<h2>Real-time Communication</h2><p>Connect your team in real-time.</p>",
            "image_urls": [
              "/images/slack-chat.png"
            ]
          }
        ]
      },
      "additional_information": "<h1>Integration Notes</h1><p>Connect via Slack API or Webhooks.</p>",
      "category_id": "019642f1-c855-7409-ad14-20a22ea2dc1b"
    }
  ],
  "meta": {
    "pagination": {}
  }
}

Application Connected

GET
/api/v1/integrations/connected

Authorization

Authorization<token>

In: header

Query Parameters

category_idstring
namestring
curl -X GET "https://api.portierx.com/api/v1/integrations/connected?category_id=%3Cstring%3E&name=%3Cstring%3E" \
  -H "Authorization: <token>"

{
  "msg": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "application_id": "string",
      "application_name": "string",
      "application_slug": "string",
      "description": "string",
      "logo_url": "string",
      "keywords": [
        "string"
      ],
      "category_id": "string",
      "category_slug": "string",
      "category_name": "string",
      "via": "string",
      "status": "string",
      "metadata": {
        "region": "string",
        "version": "string",
        "location": "string",
        "gateway_id": "string",
        "currency": "string",
        "property_id": "string",
        "channel": "string",
        "bot_name": "string"
      },
      "settings": {
        "sync_interval": "string",
        "webhook_enabled": true,
        "retry_attempts": 0,
        "notification_enabled": true,
        "track_users": true,
        "anonymize_ip": true,
        "mention_users": true,
        "thread_enabled": true
      }
    }
  ],
  "meta": {
    "pagination": {}
  }
}

Application Connected by ID

GET
/api/v1/integrations/connected/{id}

Authorization

Authorization<token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.portierx.com/api/v1/integrations/connected/019642f1-c877-7977-b6de-08c5beeb5381" \
  -H "Authorization: <token>"

{
  "msg": "string",
  "data": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "application_id": "string",
    "application_name": "string",
    "application_slug": "string",
    "description": "string",
    "logo_url": "string",
    "keywords": [
      "string"
    ],
    "features": {
      "title": "string",
      "features": [
        {
          "name": "string",
          "content": "string",
          "image_urls": [
            "string"
          ]
        }
      ]
    },
    "additional_information": "string",
    "category_id": "string",
    "category_slug": "string",
    "category_name": "string",
    "via": "string",
    "status": "string",
    "metadata": {
      "region": "string",
      "version": "string"
    },
    "settings": {
      "sync_interval": "string",
      "webhook_enabled": true
    }
  }
}

DELETE Connected by ID

DELETE
/api/v1/integrations/connected/{id}

Authorization

Authorization<token>

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.portierx.com/api/v1/integrations/connected/019642f1-c877-7977-b6de-08c5beeb5381" \
  -H "Authorization: <token>"

Get Sync

GET
/api/v1/integrations/syncs

Authorization

Authorization<token>

In: header

Query Parameters

connection_idstring
limitinteger
offsetinteger
curl -X GET "https://api.portierx.com/api/v1/integrations/syncs/?connection_id=%3Cstring%3E&limit=0&offset=0" \
  -H "Authorization: <token>"

{
  "msg": "Retrieved item list successfully",
  "data": [
    {
      "id": "019642f1-c887-78ef-8816-7cca03116e3d",
      "tenant_id": "308835417866698755",
      "connection_id": "019642f1-c877-797e-bfd1-fb4d8687710b",
      "started_at": "2025-04-17T15:51:03.944328+07:00",
      "finished_at": null,
      "error_message": null,
      "summary": "{}",
      "file_url": "https://portierxblob.blob.core.windows.net/sync-history/308835417866698755/DOM/conn456/filename-20240410123456.xml",
      "is_auto_migrate": false,
      "diff": "{}",
      "checksum": "{}",
      "status": "pending"
    },
    {
      "id": "019642f1-c887-78eb-871c-f301cb32dd27",
      "tenant_id": "308835417866698755",
      "connection_id": "019642f1-c877-7986-b636-2e9166601919",
      "started_at": "2025-04-17T15:51:03.943575+07:00",
      "finished_at": null,
      "error_message": null,
      "summary": "{\"queued\": true, \"estimated_items\": 150}",
      "file_url": null,
      "is_auto_migrate": null,
      "diff": "{}",
      "checksum": "{\"b\": \"\", \"f\": \"\", \"ac\": \"\", \"ap\": \"\", \"ls\": \"\", \"file\": \"\"}",
      "status": "pending"
    },
    {
      "id": "019642f1-c887-78e8-a14b-b1f4f0795624",
      "tenant_id": "308835417866698755",
      "connection_id": "019642f1-c877-7982-9f40-a9e158a5dd9c",
      "started_at": "2025-04-17T14:51:03.943575+07:00",
      "finished_at": null,
      "error_message": null,
      "summary": "{\"processed\": 25, \"in_progress\": true}",
      "file_url": null,
      "is_auto_migrate": null,
      "diff": "{}",
      "checksum": "{\"b\": \"\", \"f\": \"\", \"ac\": \"\", \"ap\": \"\", \"ls\": \"\", \"file\": \"\"}",
      "status": "in_progress"
    },
    {
      "id": "019642f1-c887-78e4-8dc9-56b7f5f89cec",
      "tenant_id": "308835417866698755",
      "connection_id": "019642f1-c877-797e-bfd1-fb4d8687710b",
      "started_at": "2025-04-17T03:51:03.943575+07:00",
      "finished_at": "2025-04-17T15:51:03.943575+07:00",
      "error_message": "API authentication failed",
      "summary": "{\"errors\": [\"Invalid credentials\", \"Connection timeout\"], \"processed\": 50}",
      "file_url": null,
      "is_auto_migrate": null,
      "diff": "{}",
      "checksum": "{\"b\": \"\", \"f\": \"\", \"ac\": \"\", \"ap\": \"\", \"ls\": \"\", \"file\": \"\"}",
      "status": "failed"
    },
    {
      "id": "019642f1-c887-78df-bf7c-43b628bc74a8",
      "tenant_id": "308835417866698755",
      "connection_id": "019642f1-c877-7977-b6de-08c5beeb5381",
      "started_at": "2025-04-16T15:51:03.943575+07:00",
      "finished_at": "2025-04-17T15:51:03.943575+07:00",
      "error_message": null,
      "summary": "{\"deleted\": 5, \"updated\": 15, \"inserted\": 80, \"processed\": 100}",
      "file_url": null,
      "is_auto_migrate": null,
      "diff": "{}",
      "checksum": "{\"b\": \"\", \"f\": \"\", \"ac\": \"\", \"ap\": \"\", \"ls\": \"\", \"file\": \"\"}",
      "status": "success"
    }
  ],
  "meta": {
    "pagination": {
      "current_count": 5,
      "current_page": 1,
      "per_page": 10,
      "total_pages": 1,
      "total_items": 5
    }
  }
}

Get Sync by ID

GET
/api/v1/integrations/syncs/{id}

Authorization

Authorization<token>

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.portierx.com/api/v1/integrations/syncs/01966089-dd2f-77ea-949c-478e8b408db5" \
  -H "Authorization: <token>"

{
  "msg": "Retrieved item successfully",
  "data": {
    "id": "019642f1-c887-78ef-8816-7cca03116e3d",
    "tenant_id": "308835417866698755",
    "connection_id": "019642f1-c877-797e-bfd1-fb4d8687710b",
    "started_at": "2025-04-17T15:51:03.944328+07:00",
    "finished_at": "2025-04-17T15:51:03.944328+07:00",
    "error_message": "",
    "summary": "{}",
    "file_url": "https://portierxblob.blob.core.windows.net/sync-history/308835417866698755/DOM/conn456/filename-20240410123456.xml",
    "is_auto_migrate": false,
    "diff": "{}",
    "checksum": "{}",
    "status": "pending"
  }
}

Previous

Individuals

Next

Locations