How to use the API Console

Have more questions? Submit a request

8 Comments

  • Evandro Lopes Abu Kamel Costa
    Comment actions Permalink

    Hello. Matteo.

    I'd like to know if there is a way to manage tokens created on that interface.

    Thanks.

    0
  • Bryan - Community Manager
    Comment actions Permalink

    Hello -- that page has no token management associated with it. Once a token is created, it can be seen (and removed) by the user who created it by going to their profile page, selecting the Security Settings tab, and scrolling down to see their tokens under the "Third-Party Applications" section. Know that only the user that own a token can see the token (IOW, there's no "master" admin page that can see all tokens for all users).

    You can also use the API to see token information for the user that's making the API call:
    List tokens - GET /api/v2/oauth/tokens.json
    Revoke tokens - DELETE /api/v2/oauth/tokens/{id}.json

    Hope this helps!

    0
  • Bill Greenfield
    Comment actions Permalink

    Link in article to beginner's api guide is broken

    https://develop.zendesk.com/https://support.zendesk.com/hc/en-us/articles/231426867

    0
  • Brett - Community Manager
    Comment actions Permalink

    Thanks for the heads up Bill!

    I've updated the link for you.

    Cheers :)

    0
  • Dan Cooper
    Comment actions Permalink

    The new Sunshine API endpoints have a different URL path and isn't compatible with the API Console.  Is the API console going to be updated to account for the variations in newer API endpoints? 

    0
  • Bryan - Community Manager
    Comment actions Permalink

    Hi Dan.

    I don't know of any immediate plans for this web page to support Sunshine. This API Console was developed more for Zendesk Support APIs and is a bit dated. It also doesn't support Chat APIs. I'll post any updates here if I hear more.

    My suggestion is to use a more flexible tool such as Postman, and use the Custom Objects API reference documentation link that downloads and populates Postman with a Sunshine API collection:

    0
  • Dan Cooper
    Comment actions Permalink

    Thanks! I was trying to work through an OAuth scenario and was thinking I needed to have the specific endpoint to use the implicit grant feature of the console for those test scenarios. I ended up not needing it, but I have found the postman resources useful. Thanks for following up. Are there plans to do Postman updates for other API endpoints in addition to sunshine ones?

    0
  • Bryan - Community Manager
    Comment actions Permalink

    Right now this "Sunshine" area is the only area providing a Postman collection. I know there are efforts that are reviewing how overall documentation is provided and other ways to test APIs but there's no ETA for that work.

    0

Please sign in to leave a comment.

Powered by Zendesk