Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

  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.



    Field NameField TypeDescription
    LabelString

    Required. Specify 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.

    Default Value: N/A
    ExampleREST OAuth1 Account

    Client IDString

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

    Default Value: N/A
    ExampleTDNPULHBHYKACJLDDKHCKU5GR0X6PE

    Client secretString

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

    Default Value: N/A
    ExampleN/A

    OAuth TokenString

    Auto-generated after authorization. Specify the token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.

    Default Value: N/A
    ExampleN/A

    OAuth Token SecretString

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

    Default Value: N/A
    ExampleN/A

    Request Token EndpointString

    Specify the endpoint from where the application can retrieve the request token required for the account.

    Default Value: N/A
    Examplehttps://api.xero.com/oauth/RequestToken

    Access Token Endpoint

    String

    Required. Specify the URL of the endpoint from where the application can retrieve the access tokens required for the account. 

    Default Value: N/A
    Examplehttps://api.xero.com/oauth/AccessToken

    Authorize Endpoint


    String

    Specify the endpoint that authorizes the application to access the target database.

    Default Value: N/A
    Examplehttps://api.xero.com/oauth/Authorize

    AuthorizeButton

    Click 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.

    Default Value: N/A
    Example: N/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:
    Image RemovedImage Added

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.

...