コーデンベルクのAPIリファレンスです。
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
images
.gitignore
README.md

README.md

コーデンベルク APIリファレンス

APIリファレンスは移行しました。 以下のURLをご覧ください。

https://friday-night.github.io/codenberg-api-reference/

APIリファレンスはswaggerを利用して運用しています。 ここでは、swaggerで表現しきれない事項や、お問い合わせの多い事項について以下にて機作させていただきます。

目次

認証

必要な情報

認証認可を行うためには、以下の情報が必要です。

  • APIキー
  • シークレットキー

APIキーとシークレットキーはコーデンベルク管理画面から取得できます。

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": "2016-07-17T16:46:08.724+09:00"
}

通常アクセス

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

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

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

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