APIの実行サンプル – コーデンベルクサービスデスク

目次
1. 認証方法
2. アクセストークンの取得
3. 通常アクセス

認証方法

認証認可を行うには、ログイン後の画面から確認できる「APIキー」と「シークレットキー」が必要です。

アクセストークンの取得

Basic認証形式でアクセストークンを取得します。

GET /v1/auth/token

Parameters

APIキーとシークレットキーを:(コロン)で連結した文字列をBase64エンコードして利用します。

Authorization: Basic <'APIキー' + ':' + 'シークレットキー'と連結した文字列をBase64エンコードした値>

Sample code

#!/bin/sh
APIKEY='xxxxx' #APIキー
SECRET='yyyyy' #シークレットキー
ENCODED=`echo ${APIKEY}:${SECRET} | base64`
curl https://api.codenberg.io/v1/auth/token -H "Authorization: Basic ${ENCODED}"

Response

{
"token_type": "bearer",
"access_token": "2f9af46b0212394aecc9a03e7190834a1ff4ffc1fb9f02e6a1c3ef3f32520664",
"expires": "2019-07-17T16:46:08.724+09:00"
}

通常アクセス

Authorization headerにアクセストークンを含めてアクセスします。

curl -H "Authorization: BEARER <OAUTH-TOKEN>" https://api.codenberg.io/v1/xxxxx

以下のようにquery paramsに含めてアクセスすることもできます。

GET https://api.codenberg.io/v1/xxxxx?access_token=<OAUTH-TOKEN>