明確なドキュメントと利用可能なサポートがなければ、APIの統合は成功しません。エンドポイントの説明からリクエストの例、承認ガイド、実際のケースまで、開発者が必要なすべてを手に入れる便利なシステムを作成します。
さらに、チケット、インスタントメッセンジャー、電子メールを通じて迅速なテクニカルサポートを提供し、各統合がブロッカーなしで迅速に実行されるようにします。
ドキュメントに含まれるもの
| ［セクション］ | Description（説明） |
|---|---|
| エンドポイントの説明 | メソッド、パス、パラメータ、リクエストおよびレスポンスフォーマット |
| 認可とセキュリティ | OAuth2、 JWT、 APIキーの操作例 |
| エラーコードとステータス | 可能なすべての回答の解釈（200、400、401、500など） |
| リクエストの例 | クイックスタートのための既製のカール/ポストマン/JSの例 |
| OpenAPI/Swagger | BOMからのドキュメントの自動生成 |
| FAQとガイド | よくある質問、統合手順 |
フォーマットとツール
Swagger UI、 Redoc
ポストマン/不眠症コレクション
Markdown/HTML/PDFバージョン
CI/CDにドキュメントをアップロードする機能
多言語対応（要望に応じて）
開発者サポート
EメールとSLAチケット
チームサポートのための電報/Slackグループ
大規模なパートナーのための専任エンジニア
24時間以内またはより速く答えて下さい
チケットレポートとケース履歴
ビジネス上のメリット
新規顧客の迅速な統合
エラーとヒットの削減
チーム間のコミュニケーション時間を短縮
APIによる単一の真実のソース
パートナーと開発経験の向上
特に重要な点
APIファースト製品とプラットフォーム
パブリックAPIとパートナーAPI
金融・保険サービスの統合
分割開発による内部マイクロサービス