スタートガイド

このページでは、Em Mov Coderの基本的な使い方を説明します。

以下のステップに従って、すぐにAPIを使い始めることができます。

アカウントの登録

まず、https://admin.coder.em-movimento.com/ からアカウントを登録してください。必要な情報（メールアドレス、パスワード）を入力し、登録を完了させます。

プロジェクトの作成とAPIキーの取得

アカウント登録後、管理コンソールにログインして新しいプロジェクトを作成します。プロジェクト作成時には、プロジェクト名と基本的な説明など必要な情報を入力してください。

プロジェクトが作成されたら、そのプロジェクトに連携するAPIキーを作成します。APIキーは、APIリクエストを認証するために使用され、管理コンソールからコピー可能です。

このキーを安全に保管し、公開しないように注意してください。APIリクエストを行う際に、プロジェクトIDとこのキーをヘッダーに含めて送信する必要があります。

環境の設定と認証

APIを利用するために必要な環境設定を行います。この例ではPythonを使用しますが、他のプログラミング言語でも同様に可能です。

APIへのリクエストを行う際には、Basic認証を使用して認証情報を提供する必要があります。以下のコードスニペットでは、ProjectIDをユーザー名として、APIキーをパスワードとして設定します。

import requests
from requests.auth import HTTPBasicAuth

# 認証情報の設定
project_id = 'YOUR_PROJECT_ID'  # プロジェクトIDを設定
api_key = 'YOUR_API_KEY'        # APIキーを設定
api_url = 'https://api.coder.em-movimento.com/'

# Basic認証でのリクエスト例
response = requests.get(api_url, auth=HTTPBasicAuth(project_id, api_key))

最初のAPIリクエスト

APIの基本的な機能をテストするために、Pythonを使用してBasic認証で最初のGETリクエストを行います。この方法でAPIからデータを取得し、レスポンスの内容を確認することができます。

注意: Basic認証を使用する際は、HTTPSを通じて通信を行うことで情報が暗号化されるため、セキュリティを保持できます。認証情報はコード内にハードコードせず、環境変数などを通じて安全に管理してください。

import requests
from requests.auth import HTTPBasicAuth

# 認証情報の設定
project_id = 'YOUR_PROJECT_ID'  # ここにプロジェクトIDを入力
api_key = 'YOUR_API_KEY'        # ここにAPIキーを入力
api_url = 'https://api.coder.em-movimento.com/requirements'

# Basic認証を使用してAPIリクエストを行う
response = requests.get(api_url, auth=HTTPBasicAuth(project_id, api_key))

# レスポンスデータの確認
if response.status_code == 200:
    data = response.json()
    print('API request succeeded. Data:', data)
else:
    print('API request failed with status:', response.status_code)
    print('Error message:', response.text)

Swagger UIを使用したAPIの探索

Em Mov Coder はSwagger UIをサポートしており、Webブラウザを通じてAPIのドキュメントを閲覧し、リアルタイムでAPIリクエストを試すことができます。

Swagger UIへのアクセスは以下のURLから行います。

https://api.coder.em-movimento.com/swagger-ui/index.html

Swagger UIでAPIを利用する際にも、Basic認証が必要です。ブラウザが認証情報を要求した場合、上記で使用したProjectIDをユーザー名として、APIキーをパスワードとして入力してください。

Basic認証の手順

Swagger UIのURLにアクセスします。
ブラウザが認証ダイアログを表示する場合、ユーザー名にProjectID、パスワードにAPIキーを入力します。
認証後、APIの各エンドポイントに関する詳細なドキュメントが表示され、Swagger UI上からリクエストの送信が可能になります。

このツールを利用することで、APIの各機能を簡単に理解し、テストすることができます。また、リクエストとレスポンスの構造を直接確認しながら、APIの使い方を学ぶことが可能です。

サポートとリソース

詳細なAPIの仕様について確認したい場合は、Swaggeer UIをご参照ください。

さらなる質問やサポートが必要な場合は、info@em-movimento.com までご連絡ください。