Access to the Private Preview of Queries in SKY API for R.E.

Options

Hello, I was wondering what the steps were to get access to the private preview for this endpoint:

I have a use case for my application that would utilize this endpoint.

Thanks!

Jon

Comments

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Jon Crain
    It is already publicly available.

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Jon Crain
    All of query api is publicly available

  • @Alex Wong

    I contacted support and got the following reply after getting an error using this endpoint:

    "I wanted to provide some clarification regarding the Query End Point. It is currently functioning as intended, but please note that it is in a private preview and is only accessible to a limited number of selected developers and partners.

    If you or your team would like to be considered for this group, you'll need to post to the Sky API Community to request access.

    Let me know if you have any questions or need further assistance!"

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Jon Crain
    Hi, I don't know what error you encountered, so post that to get help.

    Query API is Publicly (Generally) Available:

    https://community.blackbaud.com/blogs/69/9628

    This is announced back in 6/12/2024.

    Blackbaud Support may be confused about “Query webview” which is still in preview.

  • Daniel R. Snyder
    Daniel R. Snyder ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Alex Wong and @Jon Crain While the API is publicly available, if you don't have access to Query in webview your calls will fail, at least that was what happened when I first tried to use @Ashley Moose's template the first time. Once I got access to the Query preview it worked.

    @Erik Leaver and @David Springer maybe you can help Jon?

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Dan Snyder
    That is a surprise.

    If something is Generally Available. it is available to all, without need for the software company doing any “config”. If it is a “client” config, then client will need to know the config needed to activate or allow the use of Query API.

    Erik/David, please confirm Query API has truly GA'-ed.

  • Erik Leaver
    Erik Leaver ✭✭✭✭✭
    Ancient Membership Facilitator 4 Name Dropper Photogenic

    @Jon Crain Query API is GA as of 6/12 this year. I looked at your support case and have followed up with the analyst to confirm the GA status.

    However, I see the error message you received is about the application scope:

    This application has insufficient scope to perform the operation. This application's scopes configuration is either insufficient for the request or the Blackbaud Environment Admin has not yet approved the application's updated access configuration. Learn more: https://developer.blackbaud.com/skyapi/docs/applications/scopes"

    Did you take steps to update your application's scope?

    cc: @Alex Wong @Dan Snyder

  • @Erik Leaver
    Hello Erik, I did update my application scope to include write as I see in the docs that is required for POST calls, and then refreshed my token

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Erik Leaver
    Thanks Erik for confirming that the Query API is GA-ed and available to everyone, but yes, client do need to confirm access on their end is granted. This is the problem with BB Support when it comes to SKY API, they provide wrong info and then tell everyone to come to Community.

  • Alex Wong
    Alex Wong ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Jon Crain
    As previously mentioned, please screenshot to show how you are making the call, and the resulting errors you received.

  • Erik Leaver
    Erik Leaver ✭✭✭✭✭
    Ancient Membership Facilitator 4 Name Dropper Photogenic

    @Jon Crain Customer must also approve the scope change. As per documentation:

    When you add new functionality to your application, you can re-define your scopes and get approval for the new data access from the customer. In the customer environment, this approval is provided by a user that has the Marketplace permissions to approve scope changes.

  • Daniel R. Snyder
    Daniel R. Snyder ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Erik Leaver The scope makes sense, but Jon would not be able to write or read if his environment does not have access to Query if I am thinking about this correctly? It could be above my low-code knowledge. ?

  • @Erik Leaver
    Hi Erik,

    Do you have a link I can provide my customer where they can approve those changes?

    All the help is much appreciated!

  • Erik Leaver
    Erik Leaver ✭✭✭✭✭
    Ancient Membership Facilitator 4 Name Dropper Photogenic

    @Dan Snyder The error Jon received was regarding scopes, not access to the Query API. Query API is GA and there is no dependency on Query in the UI.

  • Daniel R. Snyder
    Daniel R. Snyder ✭✭✭✭✭
    Ninth Anniversary Facilitator 4 Name Dropper Photogenic

    @Erik Leaver Thanks!

  • @Jon Crain

    Hello all,

    Thank you for all the help, it was that the customer needed to go into Marketplace > Manage and approve my scope changes, the API is now working as expected!

    Best,

    Jon

  • Erik Leaver
    Erik Leaver ✭✭✭✭✭
    Ancient Membership Facilitator 4 Name Dropper Photogenic

    @Jon Crain Sure!

    We require environment admins to approve of scope changes when they occur after the application has been connected. We do this so the application isn't automatically granted access beyond the comfort level of the environment admin. Once the admin approves your scope change, your application should have the access it needs.

Categories