When setting up the API - it says to share the sheet with the Key what email address do you use?

Options

I have my API key and I know what sheet I want to connect through the API. The instructions say to Share the Sheet:

  • In the sharing settings, make sure that the Smartsheet API token (represented by an email address) has been added as a collaborator or viewer.
  • Click on the "Share" button or the sharing icon, usually represented by a person or silhouette, which is typically located near the top-right corner of the screen


Answers

  • jmyzk_cloudsmart_jp
    jmyzk_cloudsmart_jp ✭✭✭✭✭✭
    edited 11/15/23
    Options

    Hi @keciaheld

    I need help understanding the "Smartsheet API token (represented by an email address) " part.

    API Token looks like this.

    Are you using a third-party's API service? If so, please be careful.

    Sharing API tokens involves enormous risk, so I usually do not ask users to share a token but ask them to share a sheet to run the API service instead of the sharer.

    The instructions suggest that you have an "Editor - can share" permission to the sheet, attach your API token to the sheet, and are asked to share the sheet with someone with viewer access.

    That means you are giving access to your API token!

    I would not share my API token with someone else unless I trust the person 100%.

    May my fears be unfounded!

  • keciaheld
    Options

    I am actually having a hard time understanding on the Smartsheet side on how you are supposed to share the sheet with the API Token address - the instructions on the API set up require us to share the sheet with the token but it is confusing. I dont what to have the token unmasked for anyone who has access to the sheet share but if we have to do that I can. I also don't understand what email address you are supposed to use on the share in Smartsheet for the token.

  • jmyzk_cloudsmart_jp
    jmyzk_cloudsmart_jp ✭✭✭✭✭✭
    Options

    @keciaheld

    Is it possible to share the image of the instruction?

    '

  • keciaheld
    Options
    1. Log in to Smartsheet: Ensure that you are logged in to your Smartsheet account.
    2. Open the Sheet: Navigate to the specific sheet you want to access or update.
    3. Share the Sheet:
      • Click on the "Share" button or the sharing icon, usually represented by a person or silhouette, which is typically located near the top-right corner of the sheet.
      • In the sharing settings, make sure that the Smartsheet API token (represented by an email address) has been added as a collaborator or viewer.
    4. Set Permissions:
      • Depending on your use case, you can set the appropriate permissions for the API token:
        • If you want the API token to have full editing access to the sheet, assign it the "Editor" or "Admin" role.
        • If you only need read-only access, assign it the "Viewer" role.
      • Ensure that the API token's permissions match the level of access your Python script requires.
    5. Save Changes: After setting the sharing and permissions, make sure to save the changes.
    6. Verify Sharing: Double-check that the API token's email address is listed among the collaborators or viewers of the sheet.

    Steps 3 & 4 is what I am asking for clarification to share the sheet to the API token

  • jmyzk_cloudsmart_jp
    jmyzk_cloudsmart_jp ✭✭✭✭✭✭
    Options

    @keciaheld

    Sorry, I've never seen anything like "Smartsheet API token (represented by email address)."

  • Genevieve P.
    Genevieve P. Employee Admin
    Options

    Hi @keciaheld

    Are you getting these instructions somewhere else, perhaps using ChatGPT or another bot?

    It sounds like these are instructions to simply share the sheet. Here is Smartsheet's documentation on this: Overview: Share sheets and reports

    If you're using the API to share the sheet, you'll want to follow the instructions in the API Documentation, here: https://smartsheet.redoc.ly/tag/sharing#operation/share-sheet