Appsofsteel: Salesforce Development

Above and Beyond the Cloud Software Development

You are here: Home / Uncategorized / All Things Salesforce!

All Things Salesforce!

by 196 Comments

Creating A Salesforce Rest API

This article is specific to using Salesforce REST between servers for integration purposes.  Specifically for an enterprise server to get data to and from Salesforce.  The benefits include real time data using your business rules, the REST service can take advantage of a service layer created in apex that includes business logic, the rest service can be used by enterprise applications, mobile applications etc all sharing common business rules.

 

Overview:

  1. Create a connected app in Salesforce.
  2. Create a Global class used for REST requests
  3. Test out the connection using Curl or Postman in Google chrome.

Detail:

The first step is to create a connected app in Salesforce.

Go to Setup/App Setup/Create/Apps and scroll down to Connected Apps. Click the new button.

Give it a name.  (The name can be anything.  It is NOT used to call the service)

The API name will be created automatically or you can set it to something else. (again the api name is NOT used for calling the service)

Enter your contact email and phone number.

The logo image url and icon url is not required for our server to server communication.  The icons are used for two of the oauth2 authentication flows that expose the login screen to the user to enter their salesforce credentials.  Since this is server to server the logos are not required.

Check Enable OAuth Settings.

For server to server the callback url is not used but you have to enter something.  You can set it to anything like https://test.salesforce.com/services/oauth2/token.  Please note this example is using a sandbox for setup.  For production use https://login.salesforce.com/services/oauth2/token.

Leave use digital signatures unchecked.

For OAuth Scopes choose Access and manage your data (api).

Click Save.

A consumer key and consumer secret will be created.  These two pieces of information is required to authenticate using oauth2.

I am glossing over oauth2 which is an interesting subject.  I am just going to say that Oauth2 has 3 authentication flows that are used most often.  Two of them offer a login screen to the user to login to Salesforce for authentication and then pass control back to the calling application that is accessing Salesforce data.  This can be a web server application or a mobile application.  It is using the users authentication and approval to use the users Salesforce data in the calling application.  The third flow which is the one we are using does not pass control to the user.  It requires the server that is logging into Salesforce to pass the login and password to the server.  This has a security concern.  The password is accessible to the server so must be kept securely so others cannot access it.  The security token needs to be appended to the password.  The security token is what gets emailed to you when the password is changed in Salesforce.  The security token should be hidden from users as well.  Since this is a server to server integration it is important that the password not expire. It is never a good when you come to work and find the integration has stopped working.  The profile that this service user uses should be set to password never expires.

Lets set up the Apex class for the service.  The ficticious class below is going to get a quote created in Salesforce.

The comment before the line describes what the line does so
// This is used to call the service. The complete request would look like “https://cs3.salesforce.com/services/apexrest/v1/quote/a0JQ00000000000″
Notice the v1/quote defined in line 1.  I rev the rest request in case changes are done that may break the current version.  You can create another class with a new version allowing code written elsewhere to continue to function.  Notice also the Id of the record appended.  The method after the @HttpGet looks for the id and uses it to query the record.
1 @RestResource(urlMapping=’/v1/quote/*’)
2 global class RestQuote {
// This tells the compiler to run this method on an http get request
3 @HttpGet
// I return a quote from Salesforce
4    global static QuoteData getquote(){
5        RestRequest req = RestContext.request;
// This line extracts the id passed in the http request.
6        String QuoteId = req.requestURI.substring(req.requestURI.lastIndexOf(‘/’)+1);
// the next line could be and should be a call to a service layer class called quote that handles the business rules around quote.  I have it calling a method below.
7        QuoteData qd = getQuoteById(quoteId);
8        return qd;
}

9    private static QuoteData getQuoteById (String id){
10        QuoteData od = null;
11        List<Quote__c> quote = null;
12        try{
// I return a List instead of a single record.  I find it better for trapping errors, beyond the scope of this article.
13            quote = [Select Name, Account, …. from Quote__c where Id=:id];
}
14        catch(Exception e){
15            String error = e.getMessage();
16            qd = new QuoteData(error);
17            return qd;
}
18        if (quote.size() == 0){
19            qd = new QuoteData(‘There was no quote found’);
}
else {
20            Quote__c myQuote = quote[0];
// I am doing this to show that a class can be used to format the data before being returned.
21            qd = new QuoteData(myQuote.Name, myQuote.Account, ….);
}
22        return od;
}
// I am an inner class that can be used to format the data add business rules etc.
23    global class QuoteData{
24        String name = ”;
25        String account = ”;
26        String … = ‘…’;
27        String error = ‘none’;

28        global quoteData(String name, String account, …){
29            this.name = name;
30            this.account = account;
31            this…. = …;
}

32        global quoteData(String error){
33            this.error = error;
}
}
}

This class could work however I would not write a class like this.  Replacing GetQuoteById() on line 7 with a call to a service layer quote class that contains the business rules would be much better.  This will allow the code to be reused in visualforce pages used in the Salesforce client, any site attached to the Salesforce instance and mobile apps used against the instance.    I include the QuoteData inner class starting on line 23 to show how you can format the data and send it in the Rest request.

It will be returned in a JSON packet that looks something like this:

{name:data, account:data, error:data}

You can also return XML

Let’s make the request.  You can test out your REST request using curl.  There is a google chrome extension called postman that is easy to use as well which I show below.

First authenticate:

https://test.salesforce.com/services/oauth2/token passing the following parameters

grant_type: set equal to password

client_id: which contains the consumer key created for you when creating the connected application above.

client_secret: holds the consumer secret created for you when creating the connected application above.

username: is the username of a salesforce license user

password: is the password for the salesforce license user.  You must append the security token to the password for the authentication to work.  The security token gets emailed to you when the password is reset.

Postman Test: 

Notice the authentication is a post request.

The response will look like the following and include the access_token:

{
“id”: “https://test.salesforce.com/id/00DQ00000027rMJMAY/00580000003cONXAA2“,
“issued_at”: “1380481775164”,
“instance_url”: “https://cs3.salesforce.com“,
“signature”: “ldsjsdlfjlsdfjlsdfjfldsdtnE0XCAYEogAFw4NfBxjHupo=”,
“access_token”: “lkjflkdjflkdjflkdjfldsjflsdkfjY6yC5xU466yxh06zvKaO0xqQh42b4bFBhVkUO.xarhcT0ec8PVcBnv”
}

Use the access token in the next request:  https://cs3.salesforce.com/services/apexrest/v1quote/[id]

Note that the header key value pair is Authentication : Bearer [access token returned above]

 

 

 

 

 

 

The returned data would look something like this.

{
“Name”: “QT-00001”,
“Account”: “ACME HARDWARE”,
“…”: “…”,
“error”: “none”
}

I hope this helps others to use another awesome feature of Salesforce.

 

Comments

  27. #Hookahmagic
    Мы всегда с Вами и стараемся нести только позитив и радость.
    Ищите Нас в соцсетях,подписывайтесь и будьте в курсе последних топовых событий.
    Строго 18+

    Какой кальян купить новичку?
    Если это первая покупка, то лучше начать с более простых моделей. Это изделия со средней высотой (70 см) и одной насадкой. Количество труб влияет на работу устройства. Это будет трудная задача.

    Очень важно обращать внимание на материал шахты. Чем он прочнее, тем дольше прибор прослужит. Срок службы устройства минимум на 10 лет.

    https://h-magic.su/pharaon
    Рекомендуется обращать внимание на внутренний диаметр шахты. Он должен быть минимум 12 см.

    Можно рассмотреть также электронные изделия. Они компактные и простые в использовании. Безопасный дым. Его можно курить (парить) даже в общественных местах. Что касается его вкусовых качеств – они ничем не уступают традиционным устройствам. Какой электронный кальян купить лучше? Самый распространенный гаджет – площадь Sturbuzz.

    Reply

  41. A new company in which over half a year more than 9 million people https://crowd1.com/signup/tatyanaflorida have registered. Profit comes from the shares of the world’s largest gaming channels. Gambling, mobile share with us 50%. Passive and active income. Viber/WhatsApp +12487304178 Skype tatyana.kondratyeva2

    Reply

  57. I’m curious to find out what blog platform you happen to be working with?
    I’m having some small security issues with my latest site and I’d like to find something more safeguarded.

    Do you have any suggestions?

    Reply

  61. Всем привет!
    Норвежский дом – новые тенденции строительства домов и бань.
    Без шуток. Действительно на вашем участке можно построить дом, баню или дом-баню всего лишь за 1 день.
    Суть в том, что строительство дома, бани или дома-бани на заводе займет от 30 дней.
    Цена просто смех! Дешевле, чем 1 комн. квартира. Скажу больше, обмана здесь нет и это не маркетинговая фишка. Реально можно построить норвежский дом дешевле, чем купить квартиру.
    Конструкция стен, потолка и пола очень теплая, теплее, чем из обычных материалов. Сэкономите на отопление.
    Строительство 100% качественное без брака, с соблюдением всех строительных норм и технологических процессов.
    Если вас заинтересовало:
    Норвежский дом внутри фото
    Можете смело остановиться на своем выборе. Тем более на дом, баню или дом-баню есть гарантия от производителя!
    Всем пока!

    Reply

  66. Качественные препараты для повышения потенции http://viagraorderuk.com Усиление твердой эрекции. Продление полового акта. У нас вы можете купить таблетки Виагра, Сиалис, Левитра и другие мужские и женские возбудители для секса. Доставка анонимная по всей Украине. Вся продукция сертифицирована

    Reply

  67. Что представляет собой сайт Гидра

    Hydra — это известный маркетплейс при помощи которого, можно приобрести целый ряд запрещенных законодательством товары. Пройдя на сайт Гидра вы можете ознакомиться с каталогом. В нем представлены ассоциативы, марихуана и другие курительные смеси, экстази и опиаты. Каждый продавец имеет собственный рейтинг в системе маркетплейса, это необходимо для того, чтобы избежать встречи с мошенниками.

    Reply

  95. Revolutional update of captchas solution software “XRumer 19.0 + XEvil 5.0”:

    Captcha breaking of Google (ReCaptcha-2 and ReCaptcha-3), Facebook, BitFinex, Bing, Hotmail, SolveMedia, Yandex,
    and more than 12000 another types of captchas,
    with highest precision (80..100%) and highest speed (100 img per second).
    You can use XEvil 5.0 with any most popular SEO/SMM programms: iMacros, XRumer, SERP Parser, GSA SER, RankerX, ZennoPoster, Scrapebox, Senuke, FaucetCollector and more than 100 of other programms.

    Interested? You can find a lot of impessive videos about XEvil in YouTube.

    Free XEvil Demo available.

    See you later!

    Reply

  101. Jeddah Ksa’s best % FREE gay dating site. REAL STRAIGHT boyz seduced By Cameraman Vinnie. Smooth twinks that crave bareback anal slobber on each other’s knobs and slip inside without a condom because that’s what feels good. We also provide professional matchmaking service for gay and bisexual men in the Atlanta metropolitan area.. https://filmsuper.info/to-reaching-gay-men-in-nightclubs-4684.php The data is only saved locally (on your computer) and never transferred to us. Connect with others in a substantial way to find relationships, friendships and meaningful connections/5(). Jun 30, В В· Now that the Supreme Court has declared same-sex marriage legal in all 50 states, dreamy gay honeymoons are within reach for millions more Author: Spencer Peterson. German porn gay first time Zack then shoots a huge geyser on.

    Reply

  137. You might be my best shot fellas :/

    [url]http://gestyy.com/ewnS51[/url]
    [url]https://telegra.ph/Kak-vybrat-nadezhnogo-bukmekera-08-11[/url]
    [url]https://www.popsugar.com/profile/VinsonVinson4[/url]

    Reply

  153. I’ve tried out every thing could you help me out?:((

    [url]https://www.encarrot.com/author/leach70bitsch/[/url]
    [url]https://www.codecademy.com/profiles/lemmingcarr1[/url]

    Reply

  154. I would like to thank you for the efforts you have put in penning this
    site. I am hoping to view the same high-grade content from you in the future as well.
    In fact, your creative writing abilities has motivated me to get my own, personal site now 😉

    Reply

  170. Все для лестниц, погонаж оптом! http://35stupenek.ru/ – Комплектующие для лестниц, двери межкомнатные, перила для лестниц, мебельные щиты, балясины для лестниц, деревянные плинтуса, погонажные изделия, имитация бруса, резные деревянные картины, ступени для лестниц. Поможем с доставкой в любой регион!

    Reply

  173. Looking for an old soul like myself. Pornhub может похвастаться бесплатными Колледж видео, РІ которых представлены сотни порнозвезд. https://skyload.info/gay-leather-gloves-chaired-handjob-gluvwolf-5503.php Indeed, for those who’ve tried and failed to find the right man offline, relations can provide. “Steven Universe” is at the forefront of children’s television shows with its LGBTQ characters.

    Reply

  176. Non-binary and pansexual cast are also included. Search: i am search fo 30to35exprienced gay to help must be hindu. Topics; replies; Kevinjackson11 I’m 20 Y By Kevinjackson11; 24 Nov https://xxxsexmovies.info Whether you’re a local, new in town, or just passing through, you’ll be sure to find something on Eventbrite that piques your interest. Whether you’re looking to chat, make friends, start a relationship or keep it casual – with multiple public and private pics, a /5(K).

    Reply

  177. Всем привет!
    Норвежский дом – новые тенденции малоэтажного строительства домов и бань.
    Без шуток. Действительно на вашем участке можно построить дом, баню или дом-баню всего лишь за 1 день.
    Суть в том, что строительство дома, бани или дома-бани на заводе займет от 30 дней.
    Цена просто смех! Дешевле, чем 1 комн. квартира. Скажу больше, обмана нет и это не маркетинговый трюк. Реально построить норвежский дом можно дешевле, чем купить квартиру.
    Конструкция стен, потолка и пола очень теплая, теплее, чем из обычных материалов. Сэкономите на отопление.
    Строительство 100% качественное без брака, с соблюдением всех строительных норм и технологических процессов.
    Если вы заинтересовались:
    Построить норвежский дом
    Можете смело остановить дальнейшие поиски. Тем более на дом, баню или дом-баню есть гарантия от производителя!
    До новых встреч!

    Reply

  178. Доброго времени суток!
    Норвежский дом – новые тенденции строительства домов и бань.
    Без шуток. Действительно на вашем участке дом, баню или дом-баню можно построить всего лишь за 1 день.
    Дело в том, что строительство дома, бани или дома-бани на заводе займет от 30 дней.
    Цены просто смешные! Дешевле, чем однокомнатная квартира. Скажу больше, обмана нет и это не маркетинговый трюк. Реально построить норвежский дом можно дешевле, чем купить квартиру.
    Конструкция стен, потолка и пола реально теплая, теплее, чем из традиционных материалов. Будете экономить на отопление.
    Строительство реально качественное без брака, с соблюдением всех технологических процессов и строительных норм.
    Если вы заинтересовались:
    Построить норвежский дом
    Можете смело остановить дальнейшие поиски. Потому что производитель дает гарантию на дом, баню или дом-баню!
    До новых встреч!

    Reply

  180. With prices starting from just $/night, you can sure you’re getting the best deal. Dani modda 7 inches undi gattiga undhi. Rent Boys List for Dominican Republic escorts Found Gay/Bi-Sexual Escorts. https://forumpro.info You have come to the right place to chat. At our gay online store, we are glad to offer you an exceptional variety of classic toys, tools, restraints, and much more.

    Reply

  185. Доброго времени суток!
    Норвежский дом – новые тенденции строительства домов и бань.
    Это не шутка. Действительно на вашем участке можно построить дом, баню или дом-баню всего лишь за один день.
    Суть в том, что строительство дома, бани или дома-бани на заводе займет от 30 дней.
    Цены довольно смешные! Дешевле, чем однокомнатная квартира. Скажу больше, обмана здесь нет и это не маркетинговая фишка. Реально можно построить норвежский дом дешевле, чем купить квартиру.
    Конструкция стен, потолка и пола очень теплая, теплее, чем из обычных материалов. Сэкономите на отопление.
    Строительство реально качественное без брака, с соблюдением всех технологических процессов и строительных норм.
    Если вы заинтересовались:
    Норвежский дом Красноярск отзывы
    Можете смело остановить дальнейшие поиски. Потому что производитель дает гарантию на дом, баню или дом-баню!
    До новых встреч!

    Reply

  186. Доброго времени суток!
    Норвежский дом – новые тенденции строительства домов и бань.
    Это не шутка. Действительно на вашем участке дом, баню или дом-баню можно построить всего лишь за один день.
    Суть в том, что строительство дома, бани или дома-бани на заводе занимает от 30 дней.
    Цена просто смех! Дешевле, чем 1 комн. квартира. Скажу больше, обмана здесь нет и это не маркетинговая фишка. Реально можно построить норвежский дом дешевле, чем купить квартиру.
    Конструкция стен, потолка и пола реально теплая, теплее, чем из традиционных материалов. Будете экономить на отопление.
    Строительство 100% качественное без брака, с соблюдением всех строительных норм и технологических процессов.
    Если вам интересно:
    Норвежский дом купить в Курске
    Можете смело остановиться на своем выборе. Тем более на дом, баню или дом-баню есть гарантия от производителя!
    Увидимся!

    Reply

  188. Настоящий секс по телефону – 8-809-505-6673! https://sexcall.online/ Платы за межгород нет! Круглосуточно! 100% конфиденциально! Абсолютно легально, честно, без подписок, обмана и скрытых платежей! И самое главное – никаких запретов и ограничений! Любые сексуальные фантазии

    Reply

  189. It’s free! Miggster, the world’s leader in mobile gaming just started pre-registration! https://miggster.com/signup/tk090852 Everyone is welcome, even if you are not in Crowd1 team! Each new registration leads to exclusive rewards. Everyone starts at level 1. Once you reach level 5, you have a chance to win awesome prizes!

    Reply

  193. Балясины для лестниц от производителя! https://balyasiny-optom.ru/ Изготовим балясины и ножки для мебели любой формы: точеные, граненые, витые, резные, комбинированные (дерево + металл) из сосны, дуба, бука, ясеня. Токарные станки с ЧПУ, быстрая и качественная обработка. Шлифовка под покраску

    Reply

  194. Besame Mucho (Lyrics), Latino music https://youtu.be/9Qyvqf5-nZs Сover by Elona Krasavtseva. Pop opera songs. Music arrangement of Andrea Bocelli. Elona Krasavtseva is an award-winning singer and songwriter from Moscow, Russia. She sings classical, traditional, and original songs in different European languages

    Reply

Leave a Reply

Your email address will not be published. Required fields are marked *