REST API

API que provém do inglês Application Programming Interface, trata-se de um conjunto de rotinas e padrões estabelecidos e documentados por uma aplicação, para que os outros serviços consigam utilizar as funcionalidades desta aplicação, sem precisar conhecer os detalhes de sua implementação.

Abaixo apresentaremos recursos das API utilizados na Zoho

APIs REST

Todas as APIs seguem os padrões REST, ou seja, utilizam os métodos de solicitação HTTP GET, POST, PUT, DELETE etc.

  • GET – Buscar os registros

  • POST – Inserir novos registros

  • PUT – Atualizar os registros existentes

  • DELETE – Exclui os registros

Todas as entradas e respostas estão no formato JSON.

Todas as respostas terão um código de status HTTP.

JSON apenas

Todas as entradas e respostas da API estão apenas no formato JSON.

Algumas das vantagens de usar JSON são:

  • Menos verboso : JSON não tem tags como XML e, portanto, requer menos caracteres para representar os dados.

  • Mais rápido : como o JSON usa menos dados, é fácil ler e analisar os dados, portanto, aumenta a velocidade de análise.

  • Legível : JSON é dados muito simples e fáceis de ler.

Domínio de CRM dedicado e manipulação de DC múltiplo

As APIs Zoho CRM têm um domínio dedicado https://www.zohoapis.com/ (EUA)

Isso é útil para atender às solicitações CORS.

Os outros domínios suportados são:

  • Europa – https://www.zohoapis.eu/

  • China – https://www.zohoapis.com.cn/

  • Índia – https://www.zohoapis.in/

Alterações de endpoint

APIs têm o endpoint https://www.zohoapis.com/crm/v2/ onde
https://www.zohoapis.com é o nome do domínio e
/ crm / v2 / é o endpoint para as APIs CRM v2

Por exemplo, o URL de solicitação para obter a lista de Leads no CRM é
https://www.zohoapis.com/crm/v2/Leads

Nomes de API

As APIs Zoho CRM usam nomes de API gerados internamente durante a criação de um módulo personalizado, campo ou rótulo de lista relacionada. O sistema usa essa chave “api_name” nos dados JSON ao acessar as APIs de CRM. Isso garante que as alterações do nome do rótulo em módulos ou campos personalizados não afetem suas integrações existentes.

Por exemplo, Leads para o módulo de Negócios, currency para o campo de moeda e Notes para a lista relacionada de notas.

Paginação

Todas as respostas GET da API têm o seguinte objeto JSON “info”.

Observação

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

  • “per_page” : Use este parâmetro para definir o número de registros que você deseja buscar por página. O valor padrão é 200 .

  • “page” : Use este parâmetro para buscar os registros dessa página. O valor padrão é 1 .

  • “more_records” : este parâmetro indica se há mais registros nesse módulo. Os valores são verdadeiros ou falsos.

API de Módulos

Zoho CRM tem módulos padrão como Leads, Contas, Contatos, Negócios, Previsões, Atividades e assim por diante. Usando a API REST do Zoho CRM, você pode recuperar a lista de módulos disponíveis por meio da API Get List of Modules.

Obter lista de módulos

Propósito

Para recuperar a lista de todos os módulos disponíveis na sua conta CRM.

Pedir detalhes

Solicitar URL

https://www.zohoapis.com/crm/v2/settings/modules

Cabeçalho

Autorização: Zoho-oauthtoken d92d4xxxxxxxxxxxxxxx15f52

Escopo

scope = ZohoCRM.settings.ALL
(ou)
scope = ZohoCRM.settings.modules. {operation_type}

Possíveis tipos de operação

ALL- Acesso total aos dados
READ – Obter dados do módulo

Observação

  • Consulte a chave api_name nos dados JSON ao acessar o recurso. Cada módulo, campo e listas relacionadas terão um nome de API, que você pode usar nas integrações de terceiros. Por exemplo, se você deseja acessar o módulo Leads, use “Leads” que é o api_name toda vez que você acessar o recurso. O Zoho CRM gera um nome de API internamente ao criar um módulo personalizado, campo personalizado ou rótulo de lista relacionada. observe que você não pode alterar os nomes da API para os módulos, campos e listas relacionadas padrão. Você pode alterar os nomes da API apenas para módulos personalizados, campos e listas relacionadas.

  • O nome da API gerado pode conter apenas letras, números e sublinhados. O nome da API deve começar com um alfabeto e não deve ter dois sublinhados consecutivos ou terminar com um sublinhado.

  • Consulte a Estrutura de resposta para obter mais detalhes sobre as chaves JSON, valores e descrições dos módulos disponíveis. Você também pode usar a resposta de amostra de cada módulo como entrada ao inserir, atualizar ou fazer o upsert de um registro nesse módulo correspondente.

				
					requisicao = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2/users"
	type: GET
	connection:"crm"
];
info requisicao;
				
			

Deixe uma resposta