ベストプラクティス

DigiCert API では、開発者はかなり自由とカスタマイズが可能です。そのため、お使いの API 統合の活用方法を理解することが重要です。これらのベストプラクティスに従うことで、 API 通話の総数が抑えられ、対応時間をもっとも早めることができます。

API キー

正しいキーを使用する

API キーを生成するには,既存のユーザーにリンクする必要があります。これにより、API キーの認証と許可の両方に対応できます。API 統合の構築時、所定タスクの完了に必要な権限のある API キーを使用しているかを確認してください。

要求

同時要求は避ける

同時要求の送信は、対応時間を増やし、不測の動作の原因となる可能性があるため、お勧めしません。同時要求は、要求率制限に達するリスクが大幅に上げることにもなり、,API アクセスが一時的にブロックされます。

複数の要求を連続送信する

複数の要求を行う場合、要求は連続送信 (一度に1つずつ) し、常に応答コードを待ってから、キューにある次の要求を送信します。これで、作動中最適なデータが生成され、異常動作やエラーの可能性が大幅に抑えられます。

オーダー

常に skip_approval パラメータを含める

デフォルトでは、SSL/TLS 証明書オーダー要求には、DigiCert によるオーダー処理が可能になる前に完了が必要な 承認ステップが含まれます

オーダーの要求本文に true の値が入った skip_approval パラメータを含めることで、この承認ステップをスキップすることができます。この結果、オーダー対応時間が大幅に早まり、お客様が 即時証明書発行を利用することが可能になります。

既存の組織には ID を使用します

オーダーを既存の組織を関連づける場合は、要求本文に組織の詳細を記入する代わりに、必ず組織の ID を使用することをお勧めします。ID 値をお使いのアカウントの組織について取り込むには、[組織を一覧表示する] エンドポイントを使用します。

また、新しいオーダー要求に偶発的に割り当てられないようにするため、未使用の組織は無効にすることもお勧めします。組織を無効にするには、[組織を無効にする] エンドポイントを使用します。

オーダーステータスにステータス変更エンドポイントを使用する

オーダーの提出後、そのオーダーステータスをいつ変更し、証明書はいつダウンロード準備が完了するかが気になるでしょう。複数回電話して各オーダーのステータスをチェックするのではなく、ステータス変更リスト エンドポイントを使用します。

ステータス変更リストエンドポイントは、指定時間(過去最大7日)内にステータスを変更したオーダーを返してきます。オーダーのステータスが保留中から発行済に変更されると、お客様は返された order_id を使用して、個別オーダーの詳細を取得するか、証明書をダウンロードできます。

両バージョンのドメインを無料で取得する

単一のドメイン証明書を要求、再発行および複製する場合、個別の追加 SAN を含めるかどうかを無料で選択することができます。

両方のバージョンのドメイン ([your-domain].com と www.[your-domain].com) を安全確保するには、要求中で、 common_name パラメーターを使用してドメイン ([your-domain].com) を追加し、dns_names[] アレイで他のバージョンのドメイン (www.[your-domain].com) を追加します。コモンネーム (FQDN) のみを安全保護する場合は、要求の dns_names[] パラメータを省きます。

[SSL (type_hint) をオーダーする]エンドポイントについては、ベースドメイン (www 以外のバージョン) を common_name パラメータに、追加 SAN (www バージョン) を dns_names アレイに追加する必要があります。

Example request body
{
    "certificate": {
        "common_name": "example.com",
        "dns_names": [
            "www.example.com"
        ],
    ...