Migrando de APIs XML / JSON para as Novas APIs REST

Migrando de APIs XML / JSON para as Novas APIs REST

Nossas novas APIs REST fornecem aos desenvolvedores uma maneira aprimorada e fácil de acessar e usar os recursos e funcionalidades do Zoho Desk. Este documento lista os equivalentes da API REST para as antigas APIs XML / JSON para ajudá-lo a migrar facilmente para as novas APIs. 

Mudanças Importantes
Abaixo estão as mudanças mais importantes relacionadas à migração. 

Formato de entrada e resposta
As APIs antigas retornavam respostas nos formatos XML e JSON. Criamos as novas APIs para retornar respostas apenas no formato JSON para reduzir a complexidade e garantir facilidade de uso. 

Métodos HTTP
As novas APIs usarão métodos HTTP básicos, como GET, POST, PATCH e DELETE em solicitações de API.

Autenticação
As APIs antigas usavam o authTokens para autenticação. As novas APIs REST usam os tokens OAuth mais seguros.

orgId
As APIs antigas usavam o nome do portal em solicitações para identificar a organização no Zoho Desk. Por outro lado, as novas APIs usam o parâmetro orgId. Você pode obter o orgId de sua (s) organização (ões) usando a API "Obter todas as organizações". 
O token orgId e Oauth deve ser incluído nos cabeçalhos de todas as solicitações da API. 

A tabela a seguir lista algumas APIs XML / JSON usadas com frequência e seus equivalentes da API REST correspondentes.


APIs XML / JSON antigas
Equivalentes da API REST

/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / updaterecords  


/ api / (xml | json) / (Contatos | contatos) / updaterecords


/ api / (xml | json) / (Contas | contas) / updaterecords


/ api / (xml | json) / (Tarefas | tarefas) / updaterecords


/ api / (xml | json) / (timeentry | TimeEntry) / updaterecords


/ api / (xml | json) / (Contratos | contratos | Contrato) / updaterecords


/ api / (xml | json) / (pedidos | casos | pedidos | casos) / addrecords


/ api / (xml | json) / (Contatos | contatos) / addrecords


/ api / (xml | json) / (Contas | contas) / addrecords


/ api / (xml | json) / (Tarefas | tarefas) / addrecords


/ api / (xml | json) / (timeentry | TimeEntry) / addrecords


/ api / (xml | json) / (pedidos | casos | pedidos | casos) / getrecords



/ api / (xml | json) / (Contas | contas) / getrecords


/ api / (xml | json) / (Produtos | produtos) / getrecords


/ api / (xml | json) / (Contratos | contratos | Contrato) / getrecords


/ api / (xml | json) / (Timeentry | timeentry | TimeEntry) / getrecords


/ api / (xml | json) / (Tarefas | tarefas) / getrecords


/ api / (xml | json) / (Soluções | soluções) / getrecords


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getrecordsbyid


/ api / (xml | json) / (Contatos | contatos) / getrecordsbyid


/ api / (xml | json) / (Tarefas | tarefas) / getrecordsbyid


/ api / (xml | json) / (Contas | contas) / getrecordsbyid

/ api / (xml | json) / (Soluções | soluções) / getrecordsbyid


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getrecordsbycustomview 


https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - use o parâmetro viewId nesta solicitação da API

https://desk.zoho.com/support/APIDocument.do#Views#Views_Listallviews  - use esta API para buscar a lista de viewIds

/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getrecordsbysearch


/ api / (xml | json) / (Contatos | contatos) / getrecordsbysearch


/ api / (xml | json) / (Contas | contas) / getrecordsbysearch

/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getrecordsbyowner
https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - use o parâmetro assignee nesta solicitação da API

https://desk.zoho.com/support/APIDocument.do#Agents#Agents_Listallagents  - use essa API para buscar a lista de agentes

/ api / (xml | json) / (pedidos | casos | pedidos | casos) / deleterecords


/ api / (xml | json) / (pedidos | casos | pedidos | casos) / getrequestthreads


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getattachments


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / getattachmentslist


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / addattachments


/ api / (xml | json) / (Pedidos | Casos | pedidos | casos) / resposta


/ api / (xml | json) / (departamentos | departamento) / getalldepartments


/ api / (xml | json) / (portais | portal) / getportallist


/ api / (xml | json) / emails / getfromaddress


    • Related Articles

    • Visão geral das APIs de descanso

      Fornecemos um conjunto abrangente de APIs REST para gerenciar sua conta de suporte técnico e os dados associados. Você pode integrar módulos de help desk a outros aplicativos de terceiros, como faturamento, CRM, rastreador de bugs, portais baseados ...

    • Por que Zoho Desk?

      Sob demanda e baseado na Web  O Zoho Desk, um software de help desk on-demand, baseado na Web, permite que seus agentes se envolvam com os clientes e forneçam satisfação da maneira mais rápida e fácil. E como é tudo na nuvem, menor o custo de ...

    • Configurando o Zoho Desk para G Suite

      Você está usando o G Suite (antigo Google Apps ) para negócios? Agora você pode facilitar a colaboração das equipes de negócios e o compartilhamento de informações, configurando o Zoho Desk for G Suite. Benefícios Importe facilmente seus contatos de ...

    • SendinBlue para Zoho Desk

      Gerenciar contatos, listas e campanhas do SendinBlue. Com essa integração, as equipes de suporte podem obter facilmente a imagem completa de suas campanhas, ver seus status e até mesmo enviar campanhas diretamente do Zoho Desk. Características Do ...

    • Usando a função personalizada no Zoho Desk

      Funções personalizadas são fáceis de programar scripts, o que ajuda você a atualizar os dados em módulos de help desk relacionados ou outros aplicativos de terceiros. Quando um registro corresponde aos critérios de fluxo de trabalho, o mecanismo de ...