API de descanso do Salesforce

Api De Descanso Do Salesforce



Neste guia, abordaremos como inserir os registros no Salesforce com REST API por meio dos métodos POST e PUT http no Workbench. Como parte deste guia, discutiremos como usar o Workbench e buscar registros específicos usando sObject, buscar vários registros de um objeto usando query e buscar os registros escrevendo a API REST personalizada do Apex.

Método POST

POST é um método http que adiciona registros únicos/múltiplos por vez no Salesforce. Podemos inserir os registros com URI por meio da API Apex REST personalizada ou diretamente do URI.

Recurso de descanso personalizado no Apex

Para escrever REST no Apex, temos que utilizar algumas anotações que acessam a API REST em sua classe Apex.







Anotação @HttpPost

Esse método é chamado quando HTTP POST é enviado, o que permite que o método Apex seja exposto como um recurso REST. Em seguida, ele cria um novo recurso.



Sintaxe: @httpPost

Exemplo:



Grave a classe Apex “RestApi_Post_Record.apxc” que envolve o método REST “POST” para inserir os campos de status, prioridade e assunto no objeto “Case” do Salesforce.





  1. Crie o Post_Method com três parâmetros: status, prioridade e assunto do tipo string.
  2. Crie um objeto “Case” passando estes parâmetros.
  3. Use o DML de inserção para inserir o registro no objeto 'Caso' do Salesforce.
@RestResource(urlMapping='/v56.0/RestApi_Post_Record/')
classe global RestApi_Post_Record{

// REST - Método Post
@httpPost
global static Case Post_Method(String Priority, String Status,String Subject){
Case case_obj= new Case(Prioridade=prioridade,Status = status,Assunto=assunto);

// Inserir DML
inserir case_obj;
return case_obj;
}
}

URI e resultado:

Vá para o Workbench e navegue até o REST Explorer. Especifique o seguinte URI e execute-o:



/services/apexrest/v56.0/RestApi_Post_Record/

Especifique os dados no corpo da solicitação:

{
'Prioridade':'Alta',
'Estado':'Novo',
'Assunto':'Problema móvel'
}

Abra o registro no Salesforce (navegue até o objeto 'Case' no Iniciador de aplicativos).

Inserir um único registro diretamente do URI

Navegue até o REST Explorer na guia “Utilities” e especifique o seguinte URI e especifique este registro no Request Body:

/services/data/v56.0/sobjects/Case/

Corpo da Solicitação:

{
'Prioridade':'Média',
'Estado':'Novo',
'Assunto':'Equipes da Microsoft - Não está chegando'
}

Acesse a guia 'Casos' do Salesforce e visualize o registro.

Inserir vários registros diretamente do URI

Se você deseja inserir vários registros de uma vez, precisamos especificar o URI da seguinte forma: /services/data/v56.0/composite/tree/sObject

O Corpo da Solicitação mantém os registros no seguinte formato:

'registros' :[{
'attributes': {'type': 'Object', 'referenceId': 'reference1'},
campo: valor,
...
...
},{
'attributes': {'type': 'Object', 'referenceId': 'reference1'},
campo: valor,
...
...
}]
}

Vamos inserir dois registros no objeto “Case” do Salesforce.

URI: /services/data/v56.0/composite/tree/Case/

Corpo da Solicitação:

{
'registros' :[{
'attributes' : {'type' : 'Case', 'referenceId' : 'reference1'},
'Prioridade':'Alta',
'Estado':'Novo',
'Assunto':'Problema de projeto com rotor mecânico',
'Tipo':'Elétrico'
},{
'attributes' : {'type' : 'Case', 'referenceId' : 'reference2'},
'Prioridade':'Baixa',
'Estado':'Novo',
'Assunto':'Iniciando gerador após falha elétrica' ​​,
'Tipo':'Elétrico'
}]
}

Dois registros são inseridos no Salesforce com CaseNumber 00001038 e 00001039.

Método PUT

Como discutimos anteriormente, PUT é um método http usado para criar/atualizar os registros. Neste guia, utilizamos esse método para criar um novo registro do Salesforce usando a API REST personalizada.

@httpPut : este método é chamado quando o HTTP PUT é enviado, o que permite que o método Apex seja exposto como um recurso REST. Em seguida, ele cria um novo recurso ou atualiza o recurso existente.

Sintaxe: @httpPut

Exemplo:

Grave a classe Apex “RestApi_Put_Record.apxc” que envolve o método REST “PUT” para inserir os campos de status, prioridade e descrição no objeto “Case” do Salesforce.

@RestResource(urlMapping='/v56.0/RestApi_Put_Record/')
classe global RestApi_Put_Record{

// REST - Método Put
@httpPut
global static Case Put_Method(String Priority, String Status,String Subject){
Case case_obj= new Case(Prioridade=prioridade,Status = status,Assunto=assunto);

// Inserir DML
inserir case_obj;
return case_obj;
}
}

URI e resultado:

Vá para o Workbench e navegue até o REST Explorer. Especifique o seguinte URI e execute-o:

/services/apexrest/v56.0/RestApi_Put_Record/

Especifique os dados no corpo da solicitação:

{
'Prioridade':'Alta',
'Estado':'Fechado',
'Assunto':'Guia do Moedor de Legumes necessário'
}

Abra o registro no Salesforce (navegue até o objeto 'Case' no Iniciador de aplicativos).

Conclusão

Agora, você pode inserir os registros no Salesforce usando os métodos http PUT e POST. Aprendemos como inserir os registros diretamente no Workbench e utilizar a API REST customizada através da classe Apex. O objeto “Caso” do Salesforce é utilizado neste guia como um exemplo. A diferença real entre PUT e POST é que o POST é usado para inserir os dados, enquanto o PUT é usado para inserir/atualizar os dados. A anotação @httpPut é usada para o método PUT e a anotação @httpPost é usada para o método POST.