SkyWay Embedded SDK 0.1.0
読み取り中…
検索中…
一致する文字列を見つけられません
auth_token.h ファイル

開発用AuthTokenの生成。 [詳解]

#include <stddef.h>

[ソースコード]

データ構造

struct  skw_auth_token_t
 生成したAuthTokenを保持する構造体。 [詳解]

マクロ定義

#define SKW_AUTH_TOKEN_MAX_TOKEN_SIZE   (4096U)
 AuthTokenを格納するバッファのサイズ(NUL終端を含む)。

列挙型

enum  skw_auth_token_err_t {
  SKW_AUTH_TOKEN_OK = 0 , SKW_AUTH_TOKEN_ERR_NULL_ARGS = 1 , SKW_AUTH_TOKEN_ERR_BUFFER_OVERFLOW = 2 , SKW_AUTH_TOKEN_ERR_ENCODE_FAILED = 3 ,
  SKW_AUTH_TOKEN_ERR_INVALID_ARGS = 4 , SKW_AUTH_TOKEN_ERR_CLOCK_INVALID = 5
}
 AuthToken APIのエラーコード。 [詳解]

関数

skw_auth_token_err_t skw_auth_token_generate_for_dev (skw_auth_token_t *out_token, const char *app_id, const char *secret_key)
 SkyWayで利用するAuthTokenを生成します。このAuthTokenは開発用であり、商用環境での使用は推奨されません。

詳解

開発用AuthTokenの生成。

列挙型詳解

◆ skw_auth_token_err_t

AuthToken APIのエラーコード。

列挙値
SKW_AUTH_TOKEN_OK 

正常終了

SKW_AUTH_TOKEN_ERR_NULL_ARGS 

引数がNULL

SKW_AUTH_TOKEN_ERR_BUFFER_OVERFLOW 

出力バッファが不足

SKW_AUTH_TOKEN_ERR_ENCODE_FAILED 

AuthTokenの生成に失敗

SKW_AUTH_TOKEN_ERR_INVALID_ARGS 

引数の値が不正

SKW_AUTH_TOKEN_ERR_CLOCK_INVALID 

システム時刻が不正

関数詳解

◆ skw_auth_token_generate_for_dev()

skw_auth_token_err_t skw_auth_token_generate_for_dev ( skw_auth_token_t * out_token,
const char * app_id,
const char * secret_key )

SkyWayで利用するAuthTokenを生成します。このAuthTokenは開発用であり、商用環境での使用は推奨されません。

引数
out_token出力先のAuthTokenのポインタ
app_idアプリケーションID
secret_keyシークレットキー
戻り値
エラーコード