OpenXchangeClient.Api.Token (open_xchange_client v0.10.1)

API calls for all endpoints tagged Token.

Link to this section Summary

Functions

Gets a login token. With a valid session it is possible to acquire a secret. Using this secret another system is able to generate a valid session (see login?action=redeemToken).

Link to this section Functions

Link to this function

acquire_token(connection, session, opts \\ [])

@spec acquire_token(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, OpenXchangeClient.Model.AcquireTokenResponse.t()}
  | {:error, Tesla.Env.t()}

Gets a login token. With a valid session it is possible to acquire a secret. Using this secret another system is able to generate a valid session (see login?action=redeemToken).

parameters

Parameters

  • connection (OpenXchangeClient.Connection): Connection to server
  • session (String.t): A session ID previously obtained from the login module.
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

on success {:error, Tesla.Env.t} on failure