Versiones de API - Documento de comparación

    V2 vs. V1

    La actualización de la versión 2.0 de API de Zoho tuvo un gran impacto en el uso de las API y las funciones (anteriormente funciones personalizadas). El funcionamiento de las API es prácticamente el mismo, pero la sintaxis, la salida y los métodos son diferentes.

    El objetivo de este documento es proporcionar la clara diferencia entre las dos API, además de hacer que los usuarios comprendan mejor la versión 2.0.

    ¿Qué es diferente en la V2?

    • La respuesta API y los formatos de entrada solo son compatibles con JSON.
    • Las API serán autenticadas con el protocolo OAuth 2.0.
    • Hay nombres Api para los módulos, los campos y las listas_relacionadas en la versión 2.0, en lugar de etiquetas como en las API de la versión 1.0.
    • Los límites de llamadas API se basan en un período de 24 horas, mientras que el límite en la V 1.0 se basa en el horario de la zona estándar del Pacífico.
    • Se entregan los valores de hora y fecha en el formato ISO 8601 (2018-03-28T10:32:45+05:30).
    • Todos los nombres API que comiencen con $ son atributos de solo lectura.
    • Cuando se OBTIENE un registro, la respuesta de los campos vacíos es JSON Null.
    • Los nombres de los módulos API pueden capturarse mediante la "https://www.zohoapis.com/crm/v2/settings/modules" - URL de solicitud
    • En las API de insertar, actualizar y actualizar e ingresar, las acciones automatizadas como flujo de trabajo, aprobación y blueprint pueden activarse para todos los registros cuando se utilice la clave "trigger":[“approval”,”workflow”,”blueprint”]
    • En OBTENER API, las respuestas tendrán un JSONObject de información. Ej:

      "info": {
          "per_page": 200,
          "count": 1,
          "page": 1,
          "more_records": false
        }

      • page: para obtener la lista de registros de las respectivas páginas. El valor predeterminado es 1.
      • per_page: para obtener la lista de registros disponibles en cada página. El valor predeterminado es 200.
      • more_records es para saber si se realizarán llamadas API adicionales para capturar el siguiente conjunto de registros
    • getMyRecords(v1.0 API) se puede capturar mediante el uso de la API searchRecords en la v2.0

    Cambios de atributo de campo:

    En la versión 1.0 de APIEquivalente en la versión 2.0 de API
    {MODULE}ID (Ex. LEADID,CONTACTID,etc)id
    SMOWNERIDid ingresado en el JSONObject del Owner.
    {MODULE} OWNER (Ej. propietario principal, propietario del caso)nombre ingresado en el JSONObject del Owner.
    SMCREATORIDid ingresado dentro del JSONObject Created_By
    Created Bynombre ingresado en el JSONObject Created_By.
    MODIFIEDBYid ingresado dentro del JSONObject Modified_By
    Modified Bynombre ingresado en el JSONObject Modified_By.

    Tipos de formato de campo:

    Tipo de campoFormato V1.0Formato V2.0
    Línea única<FL val="Single_Line 1"> <![CDATA[this is single line]]> </FL>"Single_Line_1": “This is single line”,
    Multi Line<FL val="Multi-Line 1"><![CDATA[esta es la segunda línea del multi line]]></FL>"Multi_Line_1": "This is \multi line\second line",
    Correo electrónico<FL val="Email"><![CDATA[email@zoho.com]]><FL>"Email_1": "email1@email.com",
    Teléfono<FL val="Phone 1"><![CDATA[9900000000]]></FL>"Phone_1": "9900000000",
    Lista de selección<FL val="picklist1"><![CDATA[one]]></FL>"picklist1": "one",
    Búsqueda de selección múltiple<FL val="Multi-Select 1"><![CDATA[Option1;Option 2]]></FL>"Multi_Select_1": [
        "Option 1",
        "Option 2"
      ]
    Fecha<FL val="Date 1"><![CDATA[2018-03-29]]></FL>"Date_1": "2018-03-29",
    Fecha/Hora<FL val="Date/Time 1"><![CDATA[2018-04-07 10:00:00]]></FL>"Date_Time_1": "2018-04-07T10:00:00+05:30",
    Número<FL val="Number 1"><![CDATA[50000]]></FL>"Number_1": 50000,
    Moneda<FL val="Currency 1"><![CDATA[230000500]]></FL>"Currency_1": 230000500,
    Decimal<FL val="Decimal 1"><![CDATA[1234.9]]></FL>"Decimal_1": 1234.9,
    Porcentaje<FL val="Percent 1"><![CDATA[12.3]]></FL>"Percent_1": 12.3,
    Entero largo<FL val="Long Integer 1"><![CDATA[6780000000780000]]></FL>"Long_Integer_1": "6780000000780000",
    Casillas de verificación<FL val="Checkbox 1"><![CDATA[true]]></FL>"Checkbox_1": true,
    URL<FL val="URL 1"><![CDATA[https://www.zoho.com]]></FL>"URL_1": "https://www.zoho.com",
    Búsqueda<FL val="Lookup 1"><![CDATA[9500495sam]]></FL>"Lookup_1": {
        "name": "9500495sam",
        "id": "1386586000001815005"
      }
    Registrar al propietario<FL val="SMOWNERID">1386586000000078001</FL>
    <FL val="Lead Owner"<>![CDATA[BruceWills]]></FL>
    "Owner": {     "name": "Bruce Wills",     "id": "1386586000000078001"   },
    DiseñoN/A"Lookup_1": {
        "name": "9500495sam",
        "id": "1386586000001815005"
      }

    Métodos API

    Nombre del métodoFinalidad
    getRecords Recuperar todos los datos de los usuarios especificados en la solicitud de API
    getRecordByIdRecuperar registros individuales por ID de registro
    getDeletedRecordIds Recuperar la lista de ID de registros borrados de la papelera de reciclaje
    insertRecords  Insertar registros en el módulo de Zoho CRM solicitado
    updateRecords Actualizar o modificar los registros de Zoho CRM
    getSearchRecordsByPDC Buscar los valores basados en columnas predefinidas
    deleteRecordsEliminar los registros seleccionados
    convertLeadConvertir los clientes potenciales en acuerdos, cuentas y contactos
    getRelatedRecordsRecuperar los registros relacionados con un módulo principal
    getFields Recuperar  detalles de los campos disponibles en un módulo
    updateRelatedRecords Actualizar los registros relacionados a otro
    getUsers Recuperar la lista de usuarios de su organización
    uploadFile Adjuntar un archivo a un registro
    delink Desvincular la relación entre los registros principales y secundarios
    downloadFile Descargar un archivo adjunto de un registro
    deleteFile Eliminar un archivo adjunto a un registro
    uploadPhoto Agregar una foto de un contacto o cliente potencial
    downloadPhoto Eliminar una foto de un contacto o cliente potencial
    deletePhoto Eliminar una foto de un contacto o cliente potencial
    getModules Recuperar  todos los módulos de la cuenta de Zoho CRM
    searchRecords Recuperar los registros que coincidan con sus criterios de búsqueda

    Share this post : FacebookTwitter

    Todavía no puede encontrar lo que está buscando?

    Escríbenos: support@zohocrm.com