Database.com REST API Developer's Guide - Salesforce.com

More documents

Recommendations

Info

Introducing Force.com REST APIUnderstanding the User-Agent OAuth Authentication Flow1. The application redirects the user to the appropriate Database.com authorization endpoint, such ashttps://login.database.com/services/oauth2/authorize. The following parameters are required:Parameterresponse_typeclient_idredirect_uriDescriptionMust be token for this authentication flowThe Consumer Key from the remote access applicationdefinition.The Callback URL from the remote access applicationdefinition.The following parameters are optional:ParameterdisplayDescriptionChanges the login page’s display type. Valid values are:• page—Full-page authorization screen. This is the defaultvalue if none is specified.• popup—Compact dialog optimized for modern Webbrowser popup windows.• touch—Mobile-optimized dialog designed for modernsmartphones such as Android and iPhone.10
Introducing Force.com REST APIUnderstanding the User-Agent OAuth Authentication FlowParameterDescription• mobile—Mobile optimized dialog designed forsmartphones such as BlackBerry OS 5 that don’t supporttouch screens.scopestateSpecifies what data your application can access. See “ScopeParameter Values” in the online help for more information.Specifies any additional URL-encoded state data to bereturned in the callback URL after approval.An example authorization URL might look something like the following:https://login.database.com/services/oauth2/authorize?response_type=token&client_id=3MVG9lKcPoNINVBIPJjdw1J9LLJbP_pqwoJYyuisjQhr_LLurNDv7AgQvDTZwCoZuDZrXcPCmBv4o.8ds.5iE&redirect_uri=https%3A%2F%2Fwww.mysite.com%2Fuser_callback.jsp&state=mystate2. The user logs into Database.com with their credentials. The user interacts with the authorization endpoint directly, so theapplication never sees the user’s credentials.3. Once authorization is granted, the authorization endpoint redirects the user to the redirect URL. This URL is defined inthe remote access application created for the application. Database.com appends access token information to the redirectURL with the following values:Parametersaccess_tokenexpires_inrefresh_tokenDescriptionAccess token that acts as a session ID that the applicationuses for making requests. This token should be protected asthough it were user credentials.Amount of time the access token is valid, in seconds.Token that can be used in the future to obtain new accesstokens.Warning: This value is a secret. You should treatit like the user's password and use appropriatemeasures to protect it.The refresh token is only returned if the redirect URI ishttps://login.database.com/services/oauth2/successor used with a custom protocol that is not HTTPS.stateinstance_urlidThe state value that was passed in as part of the initialrequest, if applicable.Identifies the Database.com instance to which API callsshould be sent.Identity URL that can be used to both identify the user aswell as query for more information about the user. Can beused in an HTTP request to get more information aboutthe end user.11
Page 1: Version 30.0: Spring ’14Database.
Page 4 and 5: Table of ContentsGet Field Values f
Page 7 and 8: GETTING STARTED WITH THE DATABASE.C
Page 9 and 10: Introducing Force.com REST APIUsing
Page 11: Introducing Force.com REST APIUnder
Page 14 and 15: Introducing Force.com REST APIUnder
Page 22 and 23: Introducing Force.com REST APIFindi
Page 24 and 25: Chapter 3Step 2: Create Objects and
Page 26 and 27: Chapter 4Step 4: Create a Remote Ac
Page 28 and 29: Step 5: Walk Through the Sample Cod
Page 34 and 35: Using REST API ResourcesGetting Inf
Page 36 and 37: Using REST API ResourcesList Availa
Page 38 and 39: Using REST API ResourcesGet Field a
Page 40 and 41: Using REST API ResourcesWorking wit
Page 42 and 43: Using REST API ResourcesGet Field V
Page 44 and 45: Using REST API ResourcesInsert or U
Page 46 and 47: Using REST API ResourcesGet a List
Page 48 and 49: Using REST API ResourcesExecute a S
Page 50 and 51: Using REST API ResourcesGet Feedbac
Page 52 and 53: Using REST API ResourcesManage User
Page 54 and 55: Using REST API ResourcesSubmit a Re
Page 56 and 57: Using REST API ResourcesBulk Approv
Page 58 and 59: Using REST API ResourcesTrigger Pro
Page 60 and 61: ReferenceResource NameSObject RowsU
Page 62 and 63: ReferenceLimitsLimitsNote: This RES
Page 64 and 65: ReferenceSObject Get DeletedHTTP Me
Page 66 and 67:
ReferenceSObject RowsAuthentication
Page 68 and 69:
ReferenceSObject ApprovalLayoutsSOb
Page 70 and 71:
ReferenceSObject Layouts} ]}If you
Page 72 and 73:
ReferenceAppMenu• When you use th
Page 74 and 75:
ReferenceAppMenu"width" : 32,"heigh
Page 76 and 77:
ReferenceFlexiPageExample request b
Page 78 and 79:
ReferenceProcess RulesResponse body
Page 80 and 81:
ReferenceQueryParametersParameterqe
Page 82 and 83:
ReferenceQuick ActionsFor more info
Page 84 and 85:
ReferenceStatus Codes and Error Res
Page 86 and 87:
IndexIndexAAppMenu 66ApprovalLayout
show all

Database.com REST API Developer's Guide - Salesforce.com

Create successful ePaper yourself

Delete template?

Save as template?