Key/List

List one or more API keys or search for API keys using one or more of the parameters.

Parameters

Parameter	Type	Required	Description
name	string	optional	Search using the name of the key.
connected_brand_id	string	optional	Provide a specific 'brand_id' to list associated API keys.

GET https://api.recurringstack.com/{format}/Key/List

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('name' => "",'connected_brand_id' => "");
try { $response = $rstack->request('Key/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <key api_key_id="9537baf3-5899-4aea-b458-fd2d6cfererve" creation_date="2022-03-22 00:35:28" status="1">
      <name>Temp Development Key</name>
      <display_api_key>rs_key_*******************pz x</display_api_key>
      <brands>
         <brand brand_id="fc93fe37-f362-40dd-88e3-b802fe950c91" creation_date="2022-06-20 23:00:47" status="1">
            <name>Brand name here</name>
            <description>First test brand on RecurringStack with a key.</description>
         </brand>
      </brands>
      <status>1</status>
   </key>
   <key api_key_id="dv7db35-f362-40dd-88e3-b802fe950c91" creation_date="2022-06-22 00:35:28" status="1">
      <name>Production Key for March</name>
      <display_api_key>rs_key_*******************n1ud</display_api_key>
      <brands>
         <brand brand_id="fc93fe37-f362-40dd-88e3-b802fe950c91" creation_date="2022-03-20 23:00:47" status="1">
            <name>Dog Food Delivery by Max</name>
            <description>Dog food delivered fast and on time, everytime.</description>
         </brand>
      </brands>
      <status>1</status>
   </key>
</recurringstack>

{
    "key": [
        {
            "@attributes": {
                "api_key_id": "9537baf3-5899-4aea-b458-fd2d6cfererve",
                "creation_date": "2022-03-22 00:35:28",
                "status": "1"
            },
            "name": "Temp Development Key",
            "display_api_key": "rs_key_*******************pz x",
            "brands": {
                "brand": {
                    "@attributes": {
                        "brand_id": "fc93fe37-f362-40dd-88e3-b802fe950c91",
                        "creation_date": "2022-06-20 23:00:47",
                        "status": "1"
                    },
                    "name": "Brand name here",
                    "description": "First test brand on RecurringStack with a key."
                }
            },
            "status": "1"
        },
        {
            "@attributes": {
                "api_key_id": "dv7db35-f362-40dd-88e3-b802fe950c91",
                "creation_date": "2022-06-22 00:35:28",
                "status": "1"
            },
            "name": "Production Key for March",
            "display_api_key": "rs_key_*******************n1ud",
            "brands": {
                "brand": {
                    "@attributes": {
                        "brand_id": "fc93fe37-f362-40dd-88e3-b802fe950c91",
                        "creation_date": "2022-03-20 23:00:47",
                        "status": "1"
                    },
                    "name": "Dog Food Delivery by Max",
                    "description": "Dog food delivered fast and on time, everytime."
                }
            },
            "status": "1"
        }
    ]
}

API Simulator

Initiate a live call to the Key/List service using the API simulator.

name

connected_brand_id

Your API credentials are missing, click "Set Credentials" to set them.

Key/Create

Create a new API key and associate it with one or more brands.

After you create a new API key it will be returned in the response, this is the ONLY opportunity you have to view your API key in plain text.

Parameters

Parameter	Type	Required	Description
name	string	required	Provide a nickname for the API key for your records.
brands	string	required	Provide on or more 'brand_id' this API key can access. If providing multiple brands you should seperate each 'brand_id' with a comma.

POST https://api.recurringstack.com/{format}/Key/Create

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('name' => "",'brands' => "");
try { $response = $rstack->request('Key/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="479146">
   <key api_key_id="9537baf3-5899-4aea-b458-fd2d6cc35bf3" creation_date="2023-12-21 21:26:50" status="1">
      <name>Development Key</name>
      <display_api_key>rs_key_*******************pz x</display_api_key>
      <api_key>rs_key_unncgmtoiprev3443vxlnzgalpz</api_key>
      <status>1</status>
   </key>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479146"
    },
    "key": {
        "@attributes": {
            "api_key_id": "9537baf3-5899-4aea-b458-fd2d6cc35bf3",
            "creation_date": "2023-12-21 21:26:50",
            "status": "1"
        },
        "name": "Development Key",
        "display_api_key": "rs_key_*******************pz x",
        "api_key": "rs_key_unncgmtoiprev3443vxlnzgalpz",
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Key/Create service using the API simulator.

name

brands

Your API credentials are missing, click "Set Credentials" to set them.

Key/Update

You can utilize this service to update the name or brands associated with an API key.

Parameters

Parameter	Type	Required	Description
api_key_id	string	required	Provide the 'api_key_id' of the API key you wish to update.
name	string	required	Provide a nickname for the API key for your records.
brands	string	required	Provide on or more 'brand_id'(s) this API key can access. If providing multiple brands you should seperate each 'brand_id' with a comma.

PATCH https://api.recurringstack.com/{format}/Key/Update

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('api_key_id' => "",'name' => "",'brands' => "");
try { $response = $rstack->request('Key/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="479172">
  <key api_key_id="691cfc1b-d4c3-2564-8d29-2793c5cf94f6" creation_date="2022-06-23 17:26:55" status="1">
    <name>Our Main Key</name>
    <display_api_key>rs_key_*******************e3@1</display_api_key>
    <status>1</status>
  </key>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479172"
    },
    "key": {
        "@attributes": {
            "api_key_id": "691cfc1b-d4c3-2564-8d29-2793c5cf94f6",
            "creation_date": "2022-06-23 17:26:55",
            "status": "1"
        },
        "name": "Our Main Key",
        "display_api_key": "rs_key_*******************e3@1",
        "status": "1"
    }
}

API Simulator

Initiate a live call to the Key/Update service using the API simulator.

api_key_id

name

brands

Your API credentials are missing, click "Set Credentials" to set them.

Key/Delete

Use this service to delete an existing API key.

If the API key you're deleting is in use in any of your applications it will need to be replaced in all instances.

Parameters

Parameter	Type	Required	Description
api_key_id	string	required	Provide the 'api_key_id' of the API key you wish to delete.

DELETE https://api.recurringstack.com/{format}/Key/Delete

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('api_key_id' => "");
try { $response = $rstack->request('Key/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

API Simulator

Initiate a live call to the Key/Delete service using the API simulator.

api_key_id

Your API credentials are missing, click "Set Credentials" to set them.

Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout	Remove the `.boxed-layout` and `.centered-layout` classes from the `body`.
Centered Layout	Add a class `.centered-layout` to the `body`.
Boxed Layout	Add a class `.boxed-layout` to the `body`.
Boxed Layout with background image	Add background image to the `body`. <body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'> .. .. </body> Or it could be in your own class. .bg-img { background-image: url("path_to_img/image.jpg"); } <body class="boxed-layout bg-img"> .. .. </body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header	Add a class `.hd--sticky` to the `#root`.
Expanded header	Add a class `.hd--expanded` to the `#root`.
Expanded header with overlapping content.	Add a class `.overlapping` to the `#content > .content__header`.
Disable rounded header.	Add a class `.rounded-0` to the `#content > .content__header`.

Navigation

Max navigation by default	Add a class `.mn--max` to the `#root`.
Min navigation by default	Add a class `.mn--min` to the `#root`.
OffCanvas navigation with PUSH mode by default	Add a class `.mn--push` to the `#root`.
OffCanvas navigation with SLIDE mode by default	Add a class `.mn--slide` to the `#root`.
OffCanvas navigation with REVEAL mode by default	Add a class `.mn--slide` to the `#root`.
Sticky navigation	Add a class `.mn--sticky` to the `#root`.
Create a ToggleButton for navigation	Add a class `.nav-toggler` to the button. Example :

Sidebar

Disable sidebar backdrop	Add a class `.sb--bd-0` to the `#root`.
Static position	Add a class `.sb--static` to the `#root`.
Stuck sidebar as the default mode	Add a class `.sb--stuck` to the `#root`.
Unite sidebar as the default mode	Add a class `.sb--unite` to the `#root`.
Pinned sidebar as the default mode	Add a class `.sb--pinned` to the `#root`.
Toggle visibility	Toggle the class `.sb--show` in the `#root`.
Create a ToggleButton for Sidebar	Add a class `.sidebar-toggler` to the button. Example :

Animations

Add the following class to the body to change the animation transition.

Transition function name	Class name
In Quart	`.in-quart`
Out Quart	`.out-quart`
In Back	`.in-back`
Out Back	`.out-back`
In Out Back	`.in-out-back`
easeInOutBack	`.easeInOutBack`
steps	`.steps`
jumping	`.jumping`
rubber	`.rubber`