How to query Salesforce APIs in Go

jeudi 7 janvier 2016

3 minutes de lecture

Interacting with the Salesforce APIs can be tricky if your favorite language doesn't have modules or packages available to handle the complexity. Of course, you can build one from scratch. However, chances you'll hit a couple of roadblocks along the way.

A couple of weeks ago, I started working on a package to interact with the Salesforce APIs in Go, currently available on Github. My main motivations were to use it for my personal projects, to leverage existing packages such as golang.org/x/oauth2 (since all the other packages seem to rebuild this part of the logic) and to improve my understanding of both the Salesforce APIs and Go.

Here's a quick example on how to execute an SOQL query using the package.

First of, you will have to create an http client implementing the OAuth2 specification. To achieve this, github.com/jpmonette/force is leveraging the oauth2 package built by Google.

1conf := &oauth2.Config{
2	ClientID:     "CLIENT-ID",
3	ClientSecret: "CLIENT-SECRET",
4	Endpoint: oauth2.Endpoint{
5		TokenURL: "TOKEN-URL",
6	},
7}
8
9token, \_ := conf.PasswordCredentialsToken(oauth2.NoContext, "USERNAME", "PASSWORD")
10
11instanceUrl, \_ := token.Extra("instance_url").(string)
12client := conf.Client(oauth2.NoContext, token)

1conf := &oauth2.Config{
2	ClientID:     "CLIENT-ID",
3	ClientSecret: "CLIENT-SECRET",
4	Endpoint: oauth2.Endpoint{
5		TokenURL: "TOKEN-URL",
6	},
7}
8
9token, \_ := conf.PasswordCredentialsToken(oauth2.NoContext, "USERNAME", "PASSWORD")
10
11instanceUrl, \_ := token.Extra("instance_url").(string)
12client := conf.Client(oauth2.NoContext, token)

Here are the steps to obtain a functional http client:

Instantiating an oauth2.Config required to query an access_token from Salesforce - details are provided when configuring a Connected App;
Requesting an access_token using the Username-Password OAuth Flow;
Storing the instance_url from the reponse, required by the github.com/jpmonette/force package to query the correct instance;
Generating a http client implementing the OAuth2 specification.

Now that we have a functional http client, here's how to use it with the force package:

1c, \_ := force.NewClient(client, instanceUrl)
2
3var data QueryReponse
4
5c.Query("SELECT Id, Name FROM Account LIMIT 10", &data)
6
7fmt.Println("Total size: "+data.TotalSize)
8fmt.Println("First ID: "+data.Records[0].Id)

1c, \_ := force.NewClient(client, instanceUrl)
2
3var data QueryReponse
4
5c.Query("SELECT Id, Name FROM Account LIMIT 10", &data)
6
7fmt.Println("Total size: "+data.TotalSize)
8fmt.Println("First ID: "+data.Records[0].Id)

In the previous snippet, we are:

Generating a force client;
Creating a data variable using the type QueryReponse (defined later)
Executing an SOQL query using the func (c *Client) Query(query string, v interface{}) (err error) function;
Printing the amount of records returned;
Printing the Id of the first record found.

At last, you have to define the QueryReponse struct:

1type QueryReponse struct {
2	TotalSize int `json:"totalSize"`
3	Records   []struct {
4		ID         string `json:"Id"`
5		Name       string `json:"Name"`
6		Attributes struct {
7			Type string `json:"type"`
8			URL  string `json:"url"`
9		} `json:"attributes"`
10	} `json:"records"`
11}

1type QueryReponse struct {
2	TotalSize int `json:"totalSize"`
3	Records   []struct {
4		ID         string `json:"Id"`
5		Name       string `json:"Name"`
6		Attributes struct {
7			Type string `json:"type"`
8			URL  string `json:"url"`
9		} `json:"attributes"`
10	} `json:"records"`
11}

Now, here's the whole example:

1package main
2
3import (
4	"os"
5	"fmt"
6	"github.com/jpmonette/force"
7	"golang.org/x/oauth2"
8)
9
10func main() {
11	conf := &oauth2.Config{
12		ClientID:     os.Getenv("SFCLIENTID"),
13		ClientSecret: os.Getenv("SFCLIENTSECRET"),
14		Endpoint: oauth2.Endpoint{
15			TokenURL: os.Getenv("SFTOKENURL"),
16		},
17	}
18
19	token, _ := conf.PasswordCredentialsToken(oauth2.NoContext, os.Getenv("SFUSERNAME"), os.Getenv("SFPASSWORD"))
20
21	instanceUrl, _ := token.Extra("instance_url").(string)
22	client := conf.Client(oauth2.NoContext, token)
23
24	c, _ := force.NewClient(client, instanceUrl)
25
26	var data QueryReponse
27
28	c.Query("SELECT Id, Name FROM Account LIMIT 10", &data)
29
30	fmt.Println("Total size: " + data.TotalSize)
31	fmt.Println("First ID: " + data.Records[0].Id)
32
33}
34
35// QueryReponse is used to Unmarshal the SOQL query response
36type QueryReponse struct {
37	TotalSize int `json:"totalSize"`
38	Records   []struct {
39		ID         string `json:"Id"`
40		Name       string `json:"Name"`
41		Attributes struct {
42			Type string `json:"type"`
43			URL  string `json:"url"`
44		} `json:"attributes"`
45	} `json:"records"`
46}

1package main
2
3import (
4	"os"
5	"fmt"
6	"github.com/jpmonette/force"
7	"golang.org/x/oauth2"
8)
9
10func main() {
11	conf := &oauth2.Config{
12		ClientID:     os.Getenv("SFCLIENTID"),
13		ClientSecret: os.Getenv("SFCLIENTSECRET"),
14		Endpoint: oauth2.Endpoint{
15			TokenURL: os.Getenv("SFTOKENURL"),
16		},
17	}
18
19	token, _ := conf.PasswordCredentialsToken(oauth2.NoContext, os.Getenv("SFUSERNAME"), os.Getenv("SFPASSWORD"))
20
21	instanceUrl, _ := token.Extra("instance_url").(string)
22	client := conf.Client(oauth2.NoContext, token)
23
24	c, _ := force.NewClient(client, instanceUrl)
25
26	var data QueryReponse
27
28	c.Query("SELECT Id, Name FROM Account LIMIT 10", &data)
29
30	fmt.Println("Total size: " + data.TotalSize)
31	fmt.Println("First ID: " + data.Records[0].Id)
32
33}
34
35// QueryReponse is used to Unmarshal the SOQL query response
36type QueryReponse struct {
37	TotalSize int `json:"totalSize"`
38	Records   []struct {
39		ID         string `json:"Id"`
40		Name       string `json:"Name"`
41		Attributes struct {
42			Type string `json:"type"`
43			URL  string `json:"url"`
44		} `json:"attributes"`
45	} `json:"records"`
46}

Now - if you go get github.com/jpmonette/force and go run main.go, the console should output something similar to:

1~ » go run main.go
2Total size: 10
3First ID: 001b000002T9ak4

1~ » go run main.go
2Total size: 10
3First ID: 001b000002T9ak4

Notes: For simplicity, error checking has been omitted in the example.

Please note that this package is inspired by the go-github package. Since it is a work in progress, you are more than welcomed to send pull requests to support additional features. ∎