MENU
      Create site
        • PDF

        Create site

        • PDF

        Article summary

        An API that creates the site of One Click Multi DRM.
        Site list view APIs and site details view APIs are provided to view the created sites.

        Note

        The following are the precautions for creating sites:

        • A site creation can take up to 24 hours from the day of the creation. You can issue the license after creating the site.
        • You must activate the site after creating it to issue a license.
        • One Click Multi DRM supports effortless integration with NAVER Cloud Live Station products. For details on the integration, see Live Station DRM application guide.

        Requests

        POST https://multi-drm.apigw.ntruss.com/api/v1/sites
        HTTP

        Request headers

        Header nameRequirement statusDescription
        x-ncp-apigw-timestampYESThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 (UTC)
        If the time difference compared to the API Gateway server is 5 minutes or longer, then the request is considered invalid
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyYESValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeYESSpecifies the request body content type as application/json
        Content-Type: application/json
        x-ncp-region_codeYESRegion code (KR)

        Request body

        Field nameRequirement statusTypeRestrictionsDescription
        siteNameYesStringThis must be between 3 and 20 characters in length
        Special character hyphens (-) are allowed
        Name of the site to be created
        policyIdYesIntegerdefault policyId : 0Playback and security policy according to DRM type used during DRM application
        fairPlayCertOptionalObjectFairplay certification for FairPlay Streaming DRM application
        fairPlayCert.certFileOptionalStringOnly supports *.der or *.cer fileFairPlay Streaming certificate acquired from Apple
        Only supports http download URL
        fairPlayCert.privateKeyOptionalStringOnly supports *.pem filesPrivate key file of the FairPlay Streaming certificate acquired from Apple
        Only supports http download URL
        fairPlayCert.privateEncryptedStringOptionalStringPrivate key acquired upon Fairplay Streaming certificate issuance
        fairPlayCert.secretKeyOptionalStringApplication secret key (ASK) string acquired upon Fairplay Streaming certificate issuance

        Response

        Field nameRequirement statusTypeRestrictionDescription
        siteNameYesStringThis must be between 3 and 20 characters in length
        Special character hyphens (-) are allowed
        Name of the site to be created
        siteIdYesStringUnique ID of the created site
        siteStatusYesStringCREATING,READY,RUNNING,DELETEDCondition of the created site
        siteEnabledYnYesBooleanSite activation status
        policyIdYesIntegerdefault policyId : 0Playback and security policy according to DRM type used during DRM application
        fairPlayCertOptionalObjectFairplay certification for FairPlay Streaming DRM application
        fairPlayCert.certFileOptionalStringOnly supports *.der or *.cer fileFairPlay Streaming certificate acquired from Apple
        Only supports http download URL
        fairPlayCert.privateKeyOptionalStringOnly supports *.pem filesPrivate key file of the FairPlay Streaming certificate acquired from Apple
        Only supports http download URL
        fairPlayCert.privateEncryptedStringOptionalStringPrivate key acquired upon Fairplay Streaming certificate issuance
        fairPlayCert.secretKeyOptionalStringApplication secret key (ASK) string acquired upon Fairplay Streaming certificate issuance
        siteCreatedTimeYesTimestampSite creation time
        siteUpdatedTimeYesTimestampTime the site is updated

        Examples

        Request example

        POST /api/v1/sites
        HOST: multi-drm.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-timestamp:1521787414578
        x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
        x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
        x-ncp-region_code:KR
        
        Request body (if fairplayCert is ready)
        {
          "fairPlayCert": {
            "certFile": "https://kr.object.ncloudstorage.com/myBucket/myFairPlayCert.cer",
            "privateEncryptedString": "myFairPlayCertEncryptedString",
            "privateKey": "https://kr.object.ncloudstorage.com/myBucket/myFairPlayCertPrivateKey.der",
            "secretKey": "myFairPlayCertSecretKey"
          },
          "policyId": 0,
          "siteName": "myDrmSite"
        }
        
        Request body (if  fairplayCert is not ready)
        {
          "policyId": 0,
          "siteName": "myDrmSite"
        }
        HTTP

        Response example

        HTTP/1.1 200 OK
        Server: nginx
        Date: Fri, 22 Nov 2023 09:53:32 GMT
        Content-Type: application/json;charset=utf-8
        Connection: keep-alive
        Access-Control-Allow-Origin: *
        x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
        
        {
          "success": true,
          "content": {
            "siteId": "drm-20231122192776-MJTKM",
            "siteName": "myFirstDrmSite",
            "siteStatus": "CREATING",
            "siteEnabledYn": false,
            "policyId": 0,
            "fairPlayCert": {},
            "statistics": {},
            "siteCreatedTime": 1700648847450,
            "siteUpdatedTime": 1700648847450
          }
        }
        HTTP

        Was this article helpful?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.