POST /api/licenses

Adds a license.

Note: You must set up one or more resources (scopes) before adding a license. See POST /api/businesses/{BusinessID}/resources.

Authorization Roles/Permissions: Must be logged in. Must be an authorized administrator: Business Admin

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/licenses

Sample Request

The example below shows a request to add a business license.

Sample Request URL

https://{hostname}/api/licenses

Sample request headers

POST http://{hostname}/api/licenses HTTP/1.0
Host: {hostname}
Accept: application/json
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Environment":[
    "Sandbox",
    "Production"
  ],
  "Visibility":"Limited",
  "SandboxAccessAutoApproved":"true",
  "ProductionAccessAutoApproved":"false",
  "Active":true,
  "AgreementDetails":{
    "AgreementDocument":[
      {
        "Name":"AcmePaymentsCorp Legal Agreement",
        "Description":"Legal agreement for use with Platinum license",
        "ContentPath":"business/tenantbusiness.acmepaymentscorp/legal/legalagreement.txt",
        "AgreementType":"com.soa.atmosphere.legals.eula"
      }
    ]
  },
  "Name":"Platinum",
  "Description":"Top tier with unlimited throughput",
  "LicenseParts":{
    "LicensePart":[
      {
        "ResourceID":[
          "b7a419cd-2de3-4fdc-a9a6-ed1c44e62b3c.acmepaymentscorp",
          "cadddffa-cd7c-40ed-9d8b-30a0f7778563.acmepaymentscorp",
          "1a7b757f-af2c-4cf5-8e6a-a36111f92a48.acmepaymentscorp"
        ],
        "PolicyKey":[
        ]
      }
    ]
  },
  "BusinessID":"tenantbusiness.acmepaymentscorp"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
License	POST	License	Required	Contains information about an API license.

Response

If successful, this operation returns HTTP status code 200, with information about the license including the unique LicenseID.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Tue, 27 Oct 2015 14:06:07 GMT
Content-Type: application/json

Sample response body: application/json

{
  "LicenseID" : "ee987a07-304b-4f1e-8a88-8dc139f6d300.acmepaymentscorp",
  "Name" : "Platinum",
  "Description" : "Top tier with unlimited throughput",
  "Visibility" : "Limited",
  "SandboxAccessAutoApproved" : true,
  "ProductionAccessAutoApproved" : true,
  "LicenseParts":{
    "LicensePart":[
      {
        "ResourceID":[
          "b7a419cd-2de3-4fdc-a9a6-ed1c44e62b3c.acmepaymentscorp",
          "cadddffa-cd7c-40ed-9d8b-30a0f7778563.acmepaymentscorp",
          "1a7b757f-af2c-4cf5-8e6a-a36111f92a48.acmepaymentscorp"
        ],
  "BusinessID" : "tenantbusiness.acmepaymentscorp",
  "Active" : true,
  "Environment" : [ "Sandbox", "Production" ],
  "AgreementDetails" : {
    "AgreementDocument" : [ {
      "DocumentID" : "7b9ad2b2-de26-420d-9766-03b82a803ec6.acmepaymentscorp",
      "Name" : "AcmePaymentsCorp Legal Agreement",
      "Description" : "Legal agreement for use with Platinum license",
      "AgreementType" : "com.soa.atmosphere.legals.eula",
      "ResourceID" : "ee987a07-304b-4f1e-8a88-8dc139f6d300.acmepaymentscorp",
      "ContentPath" : "business/tenantbusiness.acmepaymentscorp/legal/legalagreement.txt",
      "Active" : false,
      "PrintContentPath" : "business/tenantbusiness.acmepaymentscorp/legal/legalagreement.txt"
    } ]
  }
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
License	License	Contains information about an API license.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.For example, you might get this response if you send an incorrect JSON object in the request, or specified the wrong media type in the Content-Type header.
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics