# API Portalを公開

Talend Cloud API DesignerのAPI Portal機能では、API Portalを作成してAPIのドキュメント化を一元管理することで、コンシューマーに簡単に共有できます。

![APIドキュメントを作成した後は、GitHubリポジトリーにカスタムコンテンツとブランディングを追加し、カスタムAPI Portalを公開できるようになります。](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Resources/images/api_portal_schema.png)

新しい API Portalタブで、ポータルのテンプレートを含むプライベートGitHubリポジトリーを作成できます。続いて、APIドキュメンテーションをこのリポジトリーに1回のクリックでプッシュできます。

ポータルは、静的なサイトジェネレーターHugoに基づいて、ロゴと色をブランディングに合わせて追加し、カスタムコンテンツに新しいページを追加することで、簡単にカスタマイズできます。Hugoの詳細は、[Hugo Documentation](https://gohugo.io/documentation/)をご覧ください。Hugoの最終サポートバージョンはv0.145.0です。

ポータルの設定が済めば、任意のターゲットにデプロイできます。ポータルをさまざまなターゲットにデプロイする方法の例は、[ポータルをデプロイ](https://help.qlik.com/talend/r/ja-JP/Cloud/api-portal-deployment-guide/api-portal-deployment)をご覧ください。

## API Portalの前提条件

API Portalの機能を使うには、以下が必要です。

* [API Portal - Create and edit] (API Portal - 作成および編集)権限のあるロール。この権限は事前定義された[API Portal Publisher] (API Portalパブリッシャー)ロールで利用できるほか、その他のどのロールにも追加できます。ユーザーのロールと権限はTalend Management Consoleの[Security Administrator] (セキュリティ管理者)による変更が可能です。詳細は、[ロールの管理](https://help.qlik.com/talend/r/ja-JP/Cloud/management-console-with-pipeline-designer/tmc-role-management)をご覧ください。
* プライベートリポジトリーの作成または書き込みの権限があるGitHubアカウント。GitHub Pagesに公開する場合は、プライベートリポジトリーからの公開を許可するGitHubプランが必要です。

### このセクション内

* [GitHubを使ってポータルを設定](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/configuring-api-portal-with-github)
* [別のGitプロバイダーでポータルを設定](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/configuring-api-portal-with-another-git-provider)
* [管理APIによるAPIドキュメンテーションの取得](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/fetching-api-documentation-with-management-api)
* [ポータルをカスタマイズする](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/customizing-api-portal)
* [ポータルのデプロイ](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/deploying-your-portal)
* [Talend Cloud API Testerインテグレーション](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/talend-cloud-api-tester-integration)
* [GitHub設定をリセット](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Cloud/resetting-github-settings)