Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
      • Anonymize a conversation or visitor data
    • Data & Analytics
      • Extract conversation transcript
      • Retrieve metrics and KPIs
        • Pre-aggregated indicators
        • Understand transaction data
        • Understand conversation data 1/2
        • Understand conversation data 2/2
        • Understand satisfaction data
        • Understand production indicators
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Gaperon (latest)
        • Fourme
        • Epoisses
        • Dauphin
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • Base URL
  • Authentication
  • Calls, errors & responses
  • Authentication failed
  • Read

Was this helpful?

  1. Technologies

REST API (deprecated)

Overview

Our REST API is deprecated and is replaced by our GraphQL API

Base URL

All URLs referenced in the documentation have the following base:

Standard platform
High availability platform

https://sd.iadvize.com/api/2

https://ha.iadvize.com/api/2

The iAdvize REST API is served over HTTPS.

Authentication

The API key must be attached to each request. You can use it in one of the following ways:

  • Passed in as a X-API-Key HTTP header

  • Passed in as a key GET parameter

  • Passed in as the username (with an arbitrary password) via HTTP Basic authentication

Calls, errors & responses

Authentication failed

{
  meta: {
    status: "error",
    message: "Forbidden"
  }
}

Read

GET /my_resource

{
  meta: {
    status: "success"
  },
  data: [
    {
      id: 789,
      _link: "/my_resource/789"
    },
    {
      id: 456,
      _link: "/my_resource/456"
    },
    {
      id: 123,
      _link: "/my_resource/123"
    }
  ],
  pagination: {
    page: 1,
    pages: 1,
    limit: 20,
    count: 3
  }
}

Common filters

Filter
Description
Values

page

Page number

?page=1

limit

Maximum number of resources per page (maximum possible value is 100)

?limit=1

full

Show all fields of the resource

?full=1

Use the * character to broaden the scope of your search. E.g.: filters[name]=*uli*

GET /my_resource/123

{
  meta: {
    status: "success"
  },
  data: {
    id: 123,
    my_field: "my_value",
    _link: "/my_resource/123"
  }
}

GET /my_resource/456 (with error)

{
  meta: {
    status: "fail",
    message: "Unknown 'my_resource' with 'id' 456."
  }
}
PreviousPaginationNextStatistic (deprecated)

Last updated 1 month ago

Was this helpful?