【Swift】SalesforceのREST APIを利用してみる

本稿では、主に企業で利用されているであろうSalesforceというシステムから情報を取得したり更新したりするプログラムをC#で書いてみたいと思います。

Salesforceは顧客管理などができるWebシステムです。詳細は「https://www.salesforce.com/jp/」をご覧ください。

REST APIの詳細はこちらからどうぞ。

内容



REST APIでログインを行う

ログインを行うには「https://login.salesforce.com/services/oauth2/token」へアクセスします。

methodはPOSTを指定し必要な認証パラメータを設定します。

grant_type=password
client_id=「コンシューマ鍵」
client_secret=「コンシューマの秘密」
username=「ユーザー名」
password=「パスワード」+「セキュリティートークン」

必要な値はSalesforceへログインして取得できます。

ユーザー名とパスワードはわかると思いますが、コンシューマ鍵、コンシューマの秘密、セキュリティートークンは取得方法がわからない方もいると思います。
これらの取得手順は、こちらの記事で紹介しております。

値が取得できたらログイン処理を実行してみましょう。

  1. import UIKit
  2.  
  3. class ViewController: UIViewController {
  4. 	
  5. 	override func viewDidLoad() {
  6. 		super.viewDidLoad()
  7. 		login()
  8. 	}
  9.  
  10. 	func login(){
  11. 		
  12. 		let url: String = "https://login.salesforce.com/services/oauth2/token"
  13. 		//let url: String = "https://test.salesforce.com/services/oauth2/token"//Sandbox環境の場合
  14. 		let method: String = "POST"
  15. 		let contentType: String = "application/x-www-form-urlencoded; charset=utf-8"
  16. 		var sb: String = String();
  17. 		sb.append("grant_type=password")
  18. 		sb.append("&")
  19. 		sb.append("client_id=54LOAKJL+DJALH.0224D.__jSSAFfsfM__oKLJLKFJSLKJkjLKJSdkjklsjlkdfk253Ge5153213faADdegft133")
  20. 		sb.append("&")
  21. 		sb.append("client_secret=LSFJHLS2313221SAD325FAD21321")
  22. 		sb.append("&")
  23. 		sb.append("username=test%40mail.co.jp")
  24. 		sb.append("&")
  25. 		sb.append("password=aaaasdkjLKJHGK23DA2dda")
  26. 		let body:Data? = sb.data(using: .utf8)!
  27. 		let values = executeRequest(url: url
  28. 			, method: method
  29. 			, contentType: contentType
  30. 			, accessToken: nil
  31. 			, body: body)
  32. 		
  33. 		if ( values.0 != nil && values.0!.count > 0 ) {
  34. 			print(String(data:values.0!,encoding: .utf8)!)
  35. 		} else {
  36. 			print("レスポンスがないよ!!")
  37. 		}
  38. 	}
  39. 	
  40. 	func executeRequest(url: String, method: String, contentType: String?, accessToken: String?, body: Data?)->(Data?,URLResponse?,Error?){
  41. 		var d: Data? = nil
  42. 		var r: URLResponse? = nil
  43. 		var e: Error? = nil
  44. 		let semaphore = DispatchSemaphore(value: 0)
  45. 		var request: URLRequest = URLRequest(url: URL(string: url)!)
  46. 		request.httpMethod = method
  47. 		if ( contentType != nil ) {
  48. 			request.addValue(contentType!, forHTTPHeaderField: "Content-Type")
  49. 		}
  50. 		if ( accessToken != nil ) {
  51. 			request.addValue("Bearer " + accessToken!, forHTTPHeaderField: "Authorization")
  52. 		}
  53. 		if ( body != nil ) {
  54. 			request.httpBody = body
  55. 		}
  56. 		let session: URLSession = URLSession.shared
  57. 		session.dataTask(with: request, completionHandler: { (data, response, error) in
  58. 			d = data
  59. 			r = response
  60. 			e = error
  61. 			semaphore.signal()
  62. 			
  63. 		}).resume()
  64. 		_ = semaphore.wait(timeout: .distantFuture)
  65. 		return (d, r, e)
  66. 	}
  67. }
実行結果コンソール（インデント付与済み）
{
	"access_token": "000A000A0a0A0!QAKAJDSKLNDLAS5215153153AD21312A.LKJHSADLKJAL2465461256151111010000254",
	"instance_url": "https://app.salesforce.com",
	"id": "https://login.salesforce.com/id/00D0ED/00392HJGJH00XM000000",
	"token_type": "Bearer",
	"issued_at": "73268",
	"signature": "fkhjsakdfl/jksfdljk2/b1olCBVsdsDG+zZC76ad7889DFDJKY="
}

重要なのはaccess_tokenとinstance_urlです。

これらはデータ取得や更新などをする際に必要な値となります。

access_tokenはログインした証となるものでデータ取得などをする際に必要となります。

instance_urlは実際にデータ取得などするときにアクセスするベースURLとなります。

インスタンスID（appの部分）は使用者によって変わると思います。

テストで必要であれば実際に取得できた値をメモっておきましょう。

この記事では、以降この結果をキーに設定したサンプルを掲載していきます。

REST APIでレコードを作成する

レコードを作成するには
「https://<インスタンスID>.salesforce.com/services/data/<APIバージョン>/sobjects/<オブジェクト名>」
にアクセスし、POSTを指定してリクエストします。

登録内容はJSONデータなどで指定します。

それでは取引先にレコード追加してみましょう。

取引先のオブジェクト名はAccountです。

  1. import UIKit
  2.  
  3. class ViewController: UIViewController {
  4. 	
  5. 	override func viewDidLoad() {
  6. 		super.viewDidLoad()
  7. 		create()
  8. 	}
  9. 	
  10. 	func create(){
  11. 		let url: String = "https://app.salesforce.com/services/data/v44.0/sobjects/Account"
  12. 		let method: String = "POST"
  13. 		let contentType: String = "application/json; charset=utf-8"
  14. 		let accessToken: String = "000A000A0a0A0!QAKAJDSKLNDLAS5215153153AD21312A.LKJHSADLKJAL2465461256151111010000254"
  15. 		let body: String = "{\"Name\":\"Test\"}"
  16. 		let values = executeRequest(url: url
  17. 			, method: method
  18. 			, contentType: contentType
  19. 			, accessToken: accessToken
  20. 			, body: body.data(using: .utf8))
  21. 		
  22. 		if ( values.0 != nil && values.0!.count > 0 ) {
  23. 			print(String(data:values.0!,encoding: .utf8)!)
  24. 		} else {
  25. 			print("レスポンスがないよ!!")
  26. 		}
  27. 	}
  28. 	
  29. 	func executeRequest(url: String, method: String, contentType: String?, accessToken: String?, body: Data?)->(Data?,URLResponse?,Error?){
  30. 		var d: Data? = nil
  31. 		var r: URLResponse? = nil
  32. 		var e: Error? = nil
  33. 		let semaphore = DispatchSemaphore(value: 0)
  34. 		var request: URLRequest = URLRequest(url: URL(string: url)!)
  35. 		request.httpMethod = method
  36. 		if ( contentType != nil ) {
  37. 			request.addValue(contentType!, forHTTPHeaderField: "Content-Type")
  38. 		}
  39. 		if ( accessToken != nil ) {
  40. 			request.addValue("Bearer " + accessToken!, forHTTPHeaderField: "Authorization")
  41. 		}
  42. 		if ( body != nil ) {
  43. 			request.httpBody = body
  44. 		}
  45. 		let session: URLSession = URLSession.shared
  46. 		session.dataTask(with: request, completionHandler: { (data, response, error) in
  47. 			d = data
  48. 			r = response
  49. 			e = error
  50. 			semaphore.signal()
  51. 			
  52. 		}).resume()
  53. 		_ = semaphore.wait(timeout: .distantFuture)
  54. 		return (d, r, e)
  55. 	}
  56. }
実行結果

実行結果コンソール（インデント付与済み）
{
	"id": "0011903JO01",
	"success": true,
	"errors": []
}

取引先にTestが追加されていれば成功です。

設定できるフィールドはName以外にも多数あります。
指定フィールドはAPIでも取得することはできますし、SOAP APIのレファレンスとかも見てみると案外取れたりします。

idはデータ取得、更新、削除などで使用するキーとなります。

テストで必要であれば実際の値をメモっておきましょう。この記事では以降、この結果をキーに設定したサンプルを掲載していきます。

REST APIでレコードを取得する

レコードを取得するには
「https://<インスタンスID>.salesforce.com/services/data/<APIバージョン>/sobjects/<オブジェクト名>/<オブジェクトID>」
にアクセスし、GETを指定してリクエストします。

先ほど作成したTestレコードのidを設定してデータ取得してみましょう。

  1. import UIKit
  2.  
  3. class ViewController: UIViewController {
  4. 	
  5. 	override func viewDidLoad() {
  6. 		super.viewDidLoad()
  7. 		get()
  8. 	}
  9.  
  10. 	func get(){
  11. 		
  12. 		let url: String = "https://app.salesforce.com/services/data/v44.0/sobjects/Account/0011903JO01"
  13. 		let method: String = "GET"
  14. 		let contentType: String = "application/json; charset=utf-8"
  15. 		let accessToken: String = "000A000A0a0A0!QAKAJDSKLNDLAS5215153153AD21312A.LKJHSADLKJAL2465461256151111010000254"
  16. 		let values = executeRequest(url: url
  17. 			, method: method
  18. 			, contentType: contentType
  19. 			, accessToken: accessToken
  20. 			, body: nil)
  21. 		
  22. 		if ( values.0 != nil && values.0!.count > 0 ) {
  23. 			print(String(data:values.0!,encoding: .utf8)!)
  24. 		} else {
  25. 			print("レスポンスがないよ!!")
  26. 		}
  27. 	}
  28. 	
  29. 	func executeRequest(url: String, method: String, contentType: String?, accessToken: String?, body: Data?)->(Data?,URLResponse?,Error?){
  30. 		var d: Data? = nil
  31. 		var r: URLResponse? = nil
  32. 		var e: Error? = nil
  33. 		let semaphore = DispatchSemaphore(value: 0)
  34. 		var request: URLRequest = URLRequest(url: URL(string: url)!)
  35. 		request.httpMethod = method
  36. 		if ( contentType != nil ) {
  37. 			request.addValue(contentType!, forHTTPHeaderField: "Content-Type")
  38. 		}
  39. 		if ( accessToken != nil ) {
  40. 			request.addValue("Bearer " + accessToken!, forHTTPHeaderField: "Authorization")
  41. 		}
  42. 		if ( body != nil ) {
  43. 			request.httpBody = body
  44. 		}
  45. 		let session: URLSession = URLSession.shared
  46. 		session.dataTask(with: request, completionHandler: { (data, response, error) in
  47. 			d = data
  48. 			r = response
  49. 			e = error
  50. 			semaphore.signal()
  51. 			
  52. 		}).resume()
  53. 		_ = semaphore.wait(timeout: .distantFuture)
  54. 		return (d, r, e)
  55. 	}
  56. }
実行結果コンソール（インデント付与済み）
{
	"attributes": {
		"type": "Account",
		"url": "/services/data/v44.0/sobjects/Account/0011903JO01"
	},
	"Id": "0011903JO01",
	"IsDeleted": false,
	"MasterRecordId": null,
	"Name": "Test",
	"Type": null,
	"ParentId": null,
	"BillingStreet": null,
	"BillingCity": null,
	"BillingState": null,
	"BillingPostalCode": null,
	"BillingCountry": null,
	"BillingLatitude": null,
	"BillingLongitude": null,
	"BillingGeocodeAccuracy": null,
	"BillingAddress": null,
	"ShippingStreet": null,
	"ShippingCity": null,
	"ShippingState": null,
	"ShippingPostalCode": null,
	"ShippingCountry": null,
	"ShippingLatitude": null,
	"ShippingLongitude": null,
	"ShippingGeocodeAccuracy": null,
	"ShippingAddress": null,
	"Phone": null,
	"Fax": null,
	"Website": null,
	"PhotoUrl": "/services/images/photo/0011903JO01",
	"Industry": null,
	"NumberOfEmployees": null,
	"Description": null,
	"Site": null,
	"OwnerId": "039012930",
	"CreatedDate": "2019-09-29T11:03:41.000+0000",
	"CreatedById": "039012930",
	"LastModifiedDate": "2019-09-29T11:03:41.000+0000",
	"LastModifiedById": "039012930",
	"SystemModstamp": "2019-09-29T11:03:41.000+0000",
	"LastActivityDate": null,
	"LastViewedDate": "2019-09-29T11:04:37.000+0000",
	"LastReferencedDate": "2019-09-29T11:04:37.000+0000",
	"Jigsaw": null,
	"JigsawCompanyId": null,
	"AccountSource": null,
	"SicDesc": null,
}

ほとんど値を設定していないのでnullですね。

REST APIでレコードを更新する

レコードの更新を行うには
「https://<インスタンスID>.salesforce.com/services/data/<APIバージョン>/sobjects/<オブジェクト名>/<オブジェクトID>」
にアクセスし、PATCHを指定してリクエストします。

Java11以前の標準HTTPリクエスト機能はPATCHが使えなくなっていますので、リフレクションで無理やり使えるようにしてみました。

Java11をご利用の方は新しいほうのAPIを利用することをお勧めします。

更新内容はJSON文字列で指定します。

試しに作成したTestのレコードをTest2という名前に変更してみましょう。

  1. import UIKit
  2.  
  3. class ViewController: UIViewController {
  4. 	
  5. 	override func viewDidLoad() {
  6. 		super.viewDidLoad()
  7. 		update()
  8. 	}
  9. 	
  10. 	func update(){
  11. 		
  12. 		let url: String = "https://app.salesforce.com/services/data/v44.0/sobjects/Account/0011903JO01"
  13. 		let method: String = "PATCH"
  14. 		let contentType: String = "application/json; charset=utf-8"
  15. 		let accessToken: String = "000A000A0a0A0!QAKAJDSKLNDLAS5215153153AD21312A.LKJHSADLKJAL2465461256151111010000254"
  16. 		let body: String = "{\"Name\":\"Test2\"}"
  17. 		let values = executeRequest(url: url
  18. 			, method: method
  19. 			, contentType: contentType
  20. 			, accessToken: accessToken
  21. 			, body: body.data(using: .utf8))
  22. 		
  23. 		if ( values.0 != nil && values.0!.count > 0 ) {
  24. 			print(String(data:values.0!,encoding: .utf8)!)
  25. 		} else {
  26. 			print("レスポンスがないよ!!")
  27. 		}
  28. 	}
  29. 	
  30. 	func executeRequest(url: String, method: String, contentType: String?, accessToken: String?, body: Data?)->(Data?,URLResponse?,Error?){
  31. 		var d: Data? = nil
  32. 		var r: URLResponse? = nil
  33. 		var e: Error? = nil
  34. 		let semaphore = DispatchSemaphore(value: 0)
  35. 		var request: URLRequest = URLRequest(url: URL(string: url)!)
  36. 		request.httpMethod = method
  37. 		if ( contentType != nil ) {
  38. 			request.addValue(contentType!, forHTTPHeaderField: "Content-Type")
  39. 		}
  40. 		if ( accessToken != nil ) {
  41. 			request.addValue("Bearer " + accessToken!, forHTTPHeaderField: "Authorization")
  42. 		}
  43. 		if ( body != nil ) {
  44. 			request.httpBody = body
  45. 		}
  46. 		let session: URLSession = URLSession.shared
  47. 		session.dataTask(with: request, completionHandler: { (data, response, error) in
  48. 			d = data
  49. 			r = response
  50. 			e = error
  51. 			semaphore.signal()
  52. 			
  53. 		}).resume()
  54. 		_ = semaphore.wait(timeout: .distantFuture)
  55. 		return (d, r, e)
  56. 	}
  57. }
実行結果

取引先名がTest2に変更されればOKです。

実行結果コンソール

レスポンスがないよ!!

REST APIでレコードを削除する

レコードの削除を行うには
「https://<インスタンスID>.salesforce.com/services/data/<APIバージョン>/sobjects/<オブジェクト名>/<オブジェクトID>」
にアクセスし、DELETE を指定してリクエストします。

それでは、先ほど更新したTest2のレコードを削除してみましょう。

  1. import UIKit
  2.  
  3. class ViewController: UIViewController {
  4. 	
  5. 	override func viewDidLoad() {
  6. 		super.viewDidLoad()
  7. 		delete()
  8. 	}
  9.  
  10. 	func delete(){
  11. 		
  12. 		let url: String = "https://app.salesforce.com/services/data/v44.0/sobjects/Account/0011903JO01"
  13. 		let method: String = "DELETE"
  14. 		let accessToken: String = "000A000A0a0A0!QAKAJDSKLNDLAS5215153153AD21312A.LKJHSADLKJAL2465461256151111010000254"
  15. 		let values = executeRequest(url: url
  16. 			, method: method
  17. 			, contentType: nil
  18. 			, accessToken: accessToken
  19. 			, body: nil
  20. 		)
  21. 		
  22. 		if ( values.0 != nil && values.0!.count > 0 ) {
  23. 			print(String(data:values.0!,encoding: .utf8)!)
  24. 		} else {
  25. 			print("レスポンスがないよ!!")
  26. 		}
  27. 	}
  28. 	
  29. 	func executeRequest(url: String, method: String, contentType: String?, accessToken: String?, body: Data?)->(Data?,URLResponse?,Error?){
  30. 		var d: Data? = nil
  31. 		var r: URLResponse? = nil
  32. 		var e: Error? = nil
  33. 		let semaphore = DispatchSemaphore(value: 0)
  34. 		var request: URLRequest = URLRequest(url: URL(string: url)!)
  35. 		request.httpMethod = method
  36. 		if ( contentType != nil ) {
  37. 			request.addValue(contentType!, forHTTPHeaderField: "Content-Type")
  38. 		}
  39. 		if ( accessToken != nil ) {
  40. 			request.addValue("Bearer " + accessToken!, forHTTPHeaderField: "Authorization")
  41. 		}
  42. 		if ( body != nil ) {
  43. 			request.httpBody = body
  44. 		}
  45. 		let session: URLSession = URLSession.shared
  46. 		session.dataTask(with: request, completionHandler: { (data, response, error) in
  47. 			d = data
  48. 			r = response
  49. 			e = error
  50. 			semaphore.signal()
  51. 			
  52. 		}).resume()
  53. 		_ = semaphore.wait(timeout: .distantFuture)
  54. 		return (d, r, e)
  55. 	}
  56. }
実行結果

実行結果コンソール

レスポンスがないよ!!

取引先からTest2が削除されたらOKです。

SwiftSalesforce

Posted by nompor