Api Key Service

API Documentation for https://apikeys.wbsoftwaresolutions.com

npm package available for ease of use: https://www.npmjs.com/package/api-key-service

GET Generate API Key
https://apikeys.wbsoftwaresolutions.com/api/keys

You can add any query parameter you want with a value of type string, boolean, or number. This will be set on the apiKey. Parameter enabled is not required and will default to true. You cannot set the query parameter of apiKey.

HEADERS
apikey

Get an apikey from https://apikeys.wbsoftwaresolutions.com

PARAMS
enabled

Default: true

Example Request
  • Generate API Key
                                                
GET https://apikeys.wbsoftwaresolutions.com/api/keys?enabled=true&isAdmin=true&isDev=false&ip=127.0.0.1
Example Response
200 - OK 
                                                    
{
    "apiKey": "someApiKey",
    "enabled": true,
    "isAdmin": true,
    "isDev": false,
    "ip": "127.0.0.1"
}
GET Get API Keys
https://apikeys.wbsoftwaresolutions.com/api/keys/all

This will retrieve all of your apiKeys stored in the service.

HEADERS
apikey

Get an apikey from https://apikeys.wbsoftwaresolutions.com

Example Request
  • Get API Keys
                                                
GET https://apikeys.wbsoftwaresolutions.com/api/keys/all
Example Response
200 - OK
GET Validate API Key
https://apikeys.wbsoftwaresolutions.com/api/keys/validate?apiKey=

This will validate whatever key-values you pass in are equal to the key-values of the apiKey stored in the api service. If they are all true it will only return { valid: true } otherwise it will return { valid: false, invalid: {} } where invalid will contain all the key value pairs that did not match, with the value the api service was expecting.

HEADERS
apikey

Get an apikey from https://apikeys.wbsoftwaresolutions.com

PARAMS
apiKey

The `apiKey` you want to validate

Example Request
  • Validate API Key - Valid Request
  • Validate API Key - Invalid Request
                                                
GET https://apikeys.wbsoftwaresolutions.com/api/keys/validate?apiKey=someApiKey&isAdmin=true
Example Response
200 - OK 
                                                    
{
    "valid": true
}
                                                
                                                
GET https://apikeys.wbsoftwaresolutions.com/api/keys/validate?apiKey=someApiKey&isDev=true&ip=localhost
Example Response
200 - OK 
                                                    
{
    "valid": false,
    "invalid": {
        "isDev": false,
        "ip": "127.0.0.1"
    }
}
PUT Update API Key
https://apikeys.wbsoftwaresolutions.com/api/keys?apiKey=

You can add any query parameter you want with a value of type string, boolean, or number. This will be set on the apiKey. Parameter enabled is not required and will default to true. If you do not specify a parameter that existed there earlier, it will be deleted.

HEADERS
apikey

Get an apikey from https://apikeys.wbsoftwaresolutions.com

PARAMS
apiKey

The `apiKey` you want to update

enabled

Default: true

Example Request
  • Update API Key
                                                
PUT https://apikeys.wbsoftwaresolutions.com/api/keys?apiKey=someApiKey&enabled=false&isDev=true&ip=127.0.0.1&five=5
Example Response
200 - OK 
                                                    
{
    "apiKey": "someApiKey",
    "enabled": false,
    "isDev": true,
    "ip": "127.0.0.1",
    "five": 5
}
DELETE Delete API Key
https://apikeys.wbsoftwaresolutions.com/api/keys?apiKey=

This will delete the specified apiKey.

HEADERS
apikey

Get an apikey from https://apikeys.wbsoftwaresolutions.com

PARAMS
apiKey

The `apiKey` you want to delete

Example Request
  • Delete API Key
                                                
DELETE https://apikeys.wbsoftwaresolutions.com/api/keys?apiKey=someApiKey
Example Response
200 - OK 
                                                    
{
    "apiKey": "someApiKey",
    "enabled": false,
    "isDev": true,
    "ip": "127.0.0.1",
    "five": 5
}