Example Client APIs - Developer Keys

Developer Keys - Admin Functionality

Click an API to expand/collapse it.

POSTCreate a New API Key for Example or Third Party Developer

Description

Allows an admin client to create an API Key for the Example Store App or a third party developer based on the context.

Request Endpoint

POST https://<Example api server address>/admin/developer/key

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"developerAccessRoleEnum\": \"Example\",
    \"developerName\": \"Example Llc.\"
}" \
'https://core.dev.Example.net/api/admin/developer/key'
POST body attributes (JSON)

Attribute Type Use Description

developerAccessRoleEnum String Required Can either be "Example" or "THIRD_PARTY".

developerName String Required Name of the developer.

POST body - Example
Headers: Content-Type: application/json
{
  "developerAccessRoleEnum": "Example",
  "developerName": "Example Llc."
}
Response body - Example
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "26068029-9a3e-41ef-b1fd-5410852f59d8",
    "apiKey": "c34ccc579b4a4bc40cbe73ff8533ba5e4a3e9d3efbfa2a0a17d665d7b3d319be",
    "disabled": false,
    "generatedOn": 1467629480172,
    "developerAccessRoleEnum": "Example",
    "developerName": "Example Llc."
  },
  "detail": null,
  "error": false,
  "message": "Creating developer key successful."
}
POST body - Third Party Developer
Headers: Content-Type: application/json
{
  "developerAccessRoleEnum": "THIRD_PARTY",
  "developerName": "PayLetter"
}
Response body - Third Party Developer
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "f02ca439-8ffb-4163-9432-8c7bcf446d69",
    "apiKey": "478487e7bf383a53839864368346e325e1938b3d9d53ccc0b9098a7c905ac749",
    "disabled": false,
    "generatedOn": 1467645611223,
    "developerAccessRoleEnum": "THIRD_PARTY",
    "developerName": "PayLetter"
  },
  "detail": null,
  "error": false,
  "message": "Creating developer key successful."
}
Return to top

Attribute	Type	Use	Description
`developerAccessRoleEnum`	String	Required	Can either be "Example" or "THIRD_PARTY".
`developerName`	String	Required	Name of the developer.

PATCHDisable an API Key for Casino

Description

Allows an Admin to disable a casino api key.

Request Endpoint

PATCH https://<Example api server address>/admin/casino/key/{casinoKeyId}/disable

Parameters

Parameter Type Use Description

casinoKeyId String Required The casino key id.

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/casino/key/casinoKeyId/disable'
PATCH body attributes (JSON)

Attribute Type Use Description

casinoKeyId String Required The Casino API Key Id.

Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "0c91123d-e63c-4c06-92b7-92b8d15829a0",
    "apiKey": "c5019f24e5e4d65b1d552c34b57ca33b712160d96683164b26d469902aa27fda",
    "disabled": true,
    "generatedOn": 1467110740904
  },
  "detail": null,
  "error": false,
  "message": "Disabling casino developer key successful."
}
Return to top

Parameter	Type	Use	Description
casinoKeyId	String	Required	The casino key id.

Attribute	Type	Use	Description
`casinoKeyId`	String	Required	The Casino API Key Id.

PATCHDisable an API Key for Developer

Description

Allows an admin to disable a developer api key.

Request Endpoint

PATCH https://<Example api server address>/admin/developer/key/{developerKeyId}/disable

Parameters

Parameter Type Use Description

developerKeyId String Required The developer key id.

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/developer/key/developerKeyId/disable'
PATCH body attributes (JSON)

Attribute Type Use Description

developerKeyId String Required The Developer API Key Id.

Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "26068029-9a3e-41ef-b1fd-5410852f59d8",
    "apiKey": "c34ccc579b4a4bc40cbe73ff8533ba5e4a3e9d3efbfa2a0a17d665d7b3d319be",
    "disabled": true,
    "generatedOn": 1467629480172,
    "developerAccessRoleEnum": "Example",
    "developerName": "Example Llc."
  },
  "detail": null,
  "error": false,
  "message": "Disabling developer key successful."
}
Return to top

Parameter	Type	Use	Description
developerKeyId	String	Required	The developer key id.

Attribute	Type	Use	Description
`developerKeyId`	String	Required	The Developer API Key Id.

PATCHEnable an API Key for Casino

Description

Allows an Admin to enable a casino API key.

Request Endpoint

PATCH https://<Example api server address>/admin/casino/key/{casinoKeyId}/enable

Parameters

Parameter Type Use Description

casinoKeyId String Required The casino key id.

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/casino/key/casinoKeyId/enable'
PATCH body attributes (JSON)

Attribute Type Use Description

casinoKeyId String Required The Casino API Key Id.

Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "0c91123d-e63c-4c06-92b7-92b8d15829a0",
    "apiKey": "c5019f24e5e4d65b1d552c34b57ca33b712160d96683164b26d469902aa27fda",
    "disabled": false,
    "generatedOn": 1467110740904
  },
  "detail": null,
  "error": false,
  "message": "Enabling casino developer key successful."
}
Return to top

Parameter	Type	Use	Description
casinoKeyId	String	Required	The casino key id.

Attribute	Type	Use	Description
`casinoKeyId`	String	Required	The Casino API Key Id.

PATCHEnable an API Key for Developer

Description

Allows an Admin to enable a developer api key.

Request Endpoint

PATCH https://<Example api server address>/admin/developer/key/{developerKeyId}/enable

Parameters

Parameter Type Use Description

developerKeyId String Required The developer key id.

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/developer/key/developerKeyId/enable'
PATCH body attributes (JSON)

Attribute Type Use Description

developerKeyId String Required The Developer API Key Id.

Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "26068029-9a3e-41ef-b1fd-5410852f59d8",
    "apiKey": "c34ccc579b4a4bc40cbe73ff8533ba5e4a3e9d3efbfa2a0a17d665d7b3d319be",
    "disabled": false,
    "generatedOn": 1467629480172,
    "developerAccessRoleEnum": "Example",
    "developerName": "Example Llc."
  },
  "detail": null,
  "error": false,
  "message": "Enabling developer key successful."
}
Return to top

Parameter	Type	Use	Description
developerKeyId	String	Required	The developer key id.

Attribute	Type	Use	Description
`developerKeyId`	String	Required	The Developer API Key Id.

GETFetch API Keys for Casinos

Description

Allows an admin client to fetch all the registered api keys for casinos.

Request Endpoint

GET https://<Example api server address>/admin/casino/keys?offset=0&limit=1

Parameters

Parameter Type Use Description

offset Integer Optional Enables an offset to the number of api keys being fetched.

limit Integer Optional Sets a limit to the number of api keys being fetched.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/admin/casino/keys?offset=0&limit=1'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "content": [
      {
        "id": "0c91123d-e63c-4c06-92b7-92b8d15829a0",
        "apiKey": "c5019f24e5e4d65b1d552c34b57ca33b712160d96683164b26d469902aa27fda",
        "disabled": true,
        "generatedOn": 1467110740904
      },
      {
        "id": "4b7f62ac-2b35-4153-aa86-d02ece5b7ba3",
        "apiKey": "5377f054bcd6a28bccad363feea3a635b93e6549a7908876fb7fc5d9b792c443",
        "disabled": false,
        "generatedOn": 1467110753013
      }
    ],
    "last": false,
    "totalElements": 4,
    "totalPages": 2,
    "size": 2,
    "number": 0,
    "sort": null,
    "numberOfElements": 2,
    "first": true
  },
  "detail": null,
  "error": false,
  "message": "Fetching all casino keys successful."
}
Return to top

Parameter	Type	Use	Description
offset	Integer	Optional	Enables an offset to the number of api keys being fetched.
limit	Integer	Optional	Sets a limit to the number of api keys being fetched.

GETFetch API Keys for Developers

Description

Allows an Admin client to fetch all the registered API keys for developers.

Request Endpoint

GET https://<Example api server address>/admin/developer/keys?{offset}=0&{limit}=5

Parameters

Parameter Type Use Description

offset Integer Optional Enables an offset to the number of api keys being fetched.

limit Integer Optional Sets a limit to the number of api keys being fetched.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/admin/developer/keys?offset=0&limit=5'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "content": [
      {
        "id": "26068029-9a3e-41ef-b1fd-5410852f59d8",
        "apiKey": "c34ccc579b4a4bc40cbe73ff8533ba5e4a3e9d3efbfa2a0a17d665d7b3d319be",
        "disabled": false,
        "generatedOn": 1467629480172,
        "developerAccessRoleEnum": "Example",
        "developerName": "Example Llc."
      }
    ],
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "size": 70,
    "number": 0,
    "sort": null,
    "first": true,
    "numberOfElements": 1
  },
  "detail": null,
  "error": false,
  "message": "Fetching all developer keys successful."
}
Return to top

Parameter	Type	Use	Description
offset	Integer	Optional	Enables an offset to the number of api keys being fetched.
limit	Integer	Optional	Sets a limit to the number of api keys being fetched.

PATCHGenerate a New API Key for Casino

Description

Allows an Admin to generate a casino api key. If a key has been disabled, it will automatically be enabled. Any old key will be replaced with the new one.

Request Endpoint

PATCH https://<Example api server address>/admin/casino/key/{casinoKeyId}/generate

Parameters

Parameter Type Use Description

casinoKeyId String Required The Casino API Key ID.

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/casino/key/casinoKeyId/generate'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "0c91123d-e63c-4c06-92b7-92b8d15829a0",
    "apiKey": "c4019f24e5e4d65b1d552c34b57ca33b712160d96683164b26d469902aa27fea",
    "disabled": false,
    "generatedOn": 1467110740904
  },
  "detail": null,
  "error": false,
  "message": "Generating casino developer key successful."
}
Return to top

Parameter	Type	Use	Description
casinoKeyId	String	Required	The Casino API Key ID.

PATCHGenerate a New API Key for Developer

Description

Allows an admin to generate a casino api key. If a key has been disabled, it will automatically be enabled. Any old key will be replaced with the new one.

Request Endpoint

PATCH https://<Example api server address>/admin/developer/key/{developerKeyId}/generate

Parameters

Parameter Type Use Description

developerKeyId String Required The developer key id

cURL syntax
curl --include \
     --request PATCH \
'https://core.dev.Example.net/api/admin/developer/key/developerKeyId/generate'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "26068029-9a3e-41ef-b1fd-5410852f59d8",
    "apiKey": "1f5d5a52c6963200d70a937d7fb2458aacac11c8e99e88b667f6799951503583",
    "disabled": false,
    "generatedOn": 1467629480172,
    "developerAccessRoleEnum": "Example",
    "developerName": "Example Llc."
  },
  "detail": null,
  "error": false,
  "message": "Generating developer key successful."
}
Return to top