Skip to end of banner
Go to start of banner

REST OAuth1 Account

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

In this article

Overview

Use this account type to connect REST Snaps with datasources that use OAuth1 accounts. 

Prerequisites

None.

Limitations

This account currently works only with Xero API.

Account Settings

  1. To create your REST OAuth1 account in SnapLogic, you must provide at least your Client IDClient secretRequest Token Endpoint, Access Token Endpoint, and Authorize Endpoint, and click Authorize.



    ParameterData TypeDescriptionDefault ValueExample 
    LabelStringRequired. The name for the account. We recommend that you update the account name if there is more than one account of the same account type in your project.N/AREST OAuth1 Account
    Client IDString

    Required. The client ID associated with your account. You can create the client ID as advised by your application provider. 

    N/ATDNPULHBHYKACJLDDKHCKU5GR0X6PE
    Client secretString

    Required. The client secret associated with your account. You can create the client secret as advised by your application provider. 

    N/AN/A
    OAuth TokenStringAuto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.N/AN/A
    OAuth Token SecretString

    Auto-generated after authorization. The refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires.

    N/AN/A
    Request Token EndpointStringThe endpoint from where the application can retrieve the request token required for the accountN/Ahttps://api.xero.com/oauth/RequestToken

    Access Token Endpoint

    StringRequired. The URL of the endpoint from where the application can retrieve the access tokens required for the account. N/Ahttps://api.xero.com/oauth/AccessToken

    Authorize Endpoint


    String

    The endpoint that authorizes the application to access the target database

    N/Ahttps://api.xero.com/oauth/Authorize
    AuthorizeButtonClick this button to authorize the REST OAuth1 account using the credentials provided in the Client IDClient secretRequest Token Endpoint, Access Token Endpoint, and Authorize Endpoint
    fields.
    N/AN/A
  2. On authorization, SnapLogic places a call-back to the concerned application API. On validation of the details you have entered, the target application grants access to the API and generates the required OAuth token and secret key.
    The App Details page for the instance appears.



  3. In the App Details page, enter the following details:
    1. In App name, enter the name of the app.
    2. In Company or Application Url, enter the URL of the application to which you want access.
    3. In OAuth1.0a Callback Domain, enter the callback domain for your account. For example: "https://elastic.snaplogic.com/api/1/rest/admin/oauth2callback/rest"
    4. Click Save.

  4. On validation of the details, a page appears requesting access to your data. Click Allow access for 30 minutes to enable the account to access your data for the specified period of time.


  5. Once you grant access, the OAuth Token and OAuth Token Secret fields in the Create Account popup are auto-populated, and your account is ready.

  6. When you start configuring a REST Snap, you must provide the Service URL associated with the data that you want. You can get the URL associated with the data from the application to which you want to connect.


    For example, in Xero you can retrieve the service URLs you need by selecting the Endpoint you need from the Xero Developer Platform:

SnapLogic sends your account details to the OAuth1 endpoint specified and populates the Access token, Refresh token, and Access token expiration fields using the details received from that endpoint.

Troubleshooting

ErrorReasonResolution
One or more required field is blank

You click Authorize in the account dialog window, but one or more of the following fields is blank:

  • Label
  • Client ID
  • Client secret
  • Request Token Endpoint
  • Access Token Endpoint
  • Authorize Endpoint

Insert valid details into the following fields and click Authorize.

  • Label
  • Client ID
  • Client secret
  • Request Token Endpoint
  • Access Token Endpoint
  • Authorize Endpoint

You attempted to authorize your account, but authorization failed. Thus, the following fields are empty:

  • OAuth Token
  • OAuth Token Secret

You still click Apply.

REST OAuth2 Account FAQs

When making a REST call over HTTPS, what CA bundle is the REST Snap using?

Snaplogic uses a collection of bundled trusted certificate authorities as a JRE collection in: /opt/snaplogic/pkgs/jre1.8.0_45/lib/security/cacerts.


See Also

  • No labels