Create an API credential

How to create an API credential via API

To create a new API credential, send a POST request to the /api/api_credentials endpoint, passing the resource arguments in the request body.

Request

POST https://provisioning.commercelayer.io/api/api_credentials

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.kind	string	Required
attributes.redirect_uri	string	Optional
attributes.expires_in	integer	Optional
attributes.mode	string	Optional
attributes.custom	boolean	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.organization	object	Required
relationships.role	object	Optional

Example

Request

The following request creates a new API credential:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/api_credentials' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "api_credentials",
    "attributes": {
      "name": "My app",
      "kind": "sales_channel"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "api_credentials",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde"
    },
    "attributes": {
      "name": "My app",
      "kind": "sales_channel",
      "confidential": true,
      "redirect_uri": "https://bluebrand.com/img/logo.svg",
      "client_id": "xxxx-yyyy-zzzz",
      "client_secret": "xxxx-yyyy-zzzz",
      "scopes": "market:all market:9 market:122 market:6 stock_location:6 stock_location:33",
      "expires_in": 7200,
      "mode": "test",
      "custom": false,
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "organization": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/relationships/organization",
          "related": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/organization"
        }
      },
      "role": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/relationships/role",
          "related": "https://provisioning.commercelayer.io/api/api_credentials/xYZkjABcde/role"
        }
      }
    }
  }
}