ringcentral / ringcentral/ringcentral-python

Need a simple and documented way to set auth token

Open
#39 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
56
Forks
40
PR merge metrics
No merged PRs in 30d

Description

The API Reference supports a "Try it out" feature which allows someone to copy-and-paste a code sample that just works. This system works well for cURL requests because the framework is able to insert the HTTP Bearer token directly into the "code sample." However, we cannot do that with any specific language because there is not a clear/obvious way to initialize the client/SDK with an already-existant token.

Screen Shot 2019-08-26 at 5 51 56 PM

We need a simple and single API call for getting the Bearer token in this SDK. Something to the effect of:

sdk.platform().auth().setData(...)

If a capability like this already exists, then can we add that to the documentation?

Acceptance criteria includes the very subjective criteria of the solution not feeling like a "hack." It should not feel like the developer is going into set the value via a backdoor, but by setting it via a public and sanctioned manner.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the Python SDK's client and authentication entry points, then check the API Reference's Try it out examples for any existing token-initialization method. Done means a public, sanctioned way to supply an existing Bearer token is available or documented clearly enough for generated language samples to use it without a workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, authentication
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.