Are the endpoints of api.botframework.com API is documented anywhere?

Question

We have seen that bot framework SDK uses several endpoints which are not documented anywhere, we would like to know some information about these endpoints like rate limits and these endpoints are safe to use or not?

https://api.botframework.com/api/usertoken/GetToken

https://api.botframework.com/api/botsignin/GetSignInUrl

Answer 1

Hello Hasit Parmar

Welcome to the Microsoft Q&A and thank you for posting your questions here.

Problem

I understand that you would like to know more information about https://api.botframework.com/api/usertoken/GetToken and https://api.botframework.com/api/botsignin/GetSignInUrlendpoints sch as rate limit, purpose and safety of these endpoints.

Solution

The endpoints you mentioned are used by the Bot Framework SDK for specific authentication and token management purposes. The endpoints for api.botframework.com are not officially documented by Microsoft. The main documentation for the Bot Framework SDK focuses on how to interact with the Bot Framework using the SDK, rather than directly using specific API endpoints like https://api.botframework.com/api/usertoken/GetToken and https://api.botframework.com/api/botsignin/GetSignInUrl.

So, to clarify the points of the question I put together the below breakdown of each endpoint:

1. https://api.botframework.com/api/usertoken/GetToken:

• Purpose: This endpoint is used to obtain a token for a user, which is necessary for the bot to access resources on the user's behalf.
• Rate Limits: Microsoft does not provide specific documentation on the rate limits for this endpoint. However, the Bot Framework services typically have rate limiting to prevent abuse and ensure fair usage.
• Safety: Since this is an undocumented endpoint, it is not guaranteed to be stable or supported in the long term. Using undocumented endpoints carries the risk that they might change without notice, potentially disrupting your application.

2. https://api.botframework.com/api/botsignin/GetSignInUrl:

• Purpose: This endpoint generates a sign-in URL for the user, which is used in scenarios where the bot needs the user to authenticate or give consent.
• Rate Limits: Like the GetToken endpoint, specific rate limits are not publicly documented. The Bot Framework infrastructure manages usage patterns and limits.
• Safety: As an undocumented endpoint, it may change or be deprecated without prior notice, which can pose a risk to the stability of your application.

References

To find more information about these endpoints, you might consider the following references:

Source: Bot Framework SDK GitHub. Accessed, 7/19/2024.

Source: Bot Framework Documentation. Accessed, 7/19/2024.

Source: Stack Overflow Bot Framework Tag. Accessed, 7/19/2024.

Source: GitHub Discussions for Bot Framework. Accessed, 7/19/2024.

Source: Network Inspection Tools - Fiddler. Accessed, 7/19/2024.

Source: Chrome DevTools Network Inspection. Accessed, 7/19/2024.

Accept Answer

I hope this is helpful! Do not hesitate to let me know if you have any other questions.

** Please don't forget to close up the thread here by upvoting and accept it as an answer if it is helpful ** so that others in the community facing similar issues can easily find the solution.

Best Regards,

Sina Salam