Skip to content
Snippets Groups Projects
Commit 1158ea3f authored by Jared Hancock's avatar Jared Hancock Committed by Peter Rotich
Browse files

tips: Add tips for api-keys

parent dc84ca79
No related branches found
No related tags found
No related merge requests found
#
# This is popup help messages for the Admin Panel -> Manage -> Add New API Key
#
# Fields:
# title - Shown in bold at the top of the popover window
# content - The body of the help popover
# links - List of links shows below the content
# title - Link title
# href - href of link (links starting with / are translated to the
# helpdesk installation path)
#
# The key names such as 'helpdesk_name' should not be translated as they
# must match the HTML #ids put into the page template.
#
---
status:
title: Status
content: >
ip_address:
title: IP Address
content: >
services:
title: Services
content: >
can_create_tickets:
title: Can Create Tickets
content: >
Define various options (XML/JSON/Email) and how they will affect the user
experience.
can_execute_cron:
title: Can Execute Cron
content: >
<span class="doc-tip-title">Cron</span> is a techincal reference to
scheduled tasks. Allowing cron execution via the API enables usage
of the <cron>rcron.php</cron> script packaged in the
<code>scripts/</code> folder with the system.
......@@ -13,22 +13,20 @@
# must match the HTML #ids put into the page template.
#
---
add_new_api_key:
title: Add New API Key
content: >
api_keys_table:
title: API Keys
content: >
api_key:
title: API Key
content: >
API keys are used to authenticate clients submitting new tickets via
the Application Programming Interface (API). API keys are used
instead of passwords. Since API keys may be sent unencrypted, they
are linked to each client's network IP address.
links:
- title: osTicket API Documentation
href: https://github.com/osTicket/osTicket-1.8/blob/develop/setup/doc/api.md
ip_addr:
title: IP Address
content: >
status:
title: Status
content: >
Client's network IP address. Each unique client IP address will
require separate API keys
......@@ -22,7 +22,9 @@ $info=Format::htmlchars(($errors && $_POST)?$_POST:$info);
<input type="hidden" name="do" value="<?php echo $action; ?>">
<input type="hidden" name="a" value="<?php echo Format::htmlchars($_REQUEST['a']); ?>">
<input type="hidden" name="id" value="<?php echo $info['id']; ?>">
<h2>API Key</h2>
<h2>API Key
<i class="help-tip icon-question-sign" href="#api_key"></i>
</h2>
<table class="form_table" width="940" border="0" cellspacing="0" cellpadding="2">
<thead>
<tr>
......@@ -49,7 +51,10 @@ $info=Format::htmlchars(($errors && $_POST)?$_POST:$info);
IP Address:
</td>
<td>
<span>
<?php echo $api->getIPAddr(); ?>
<i class="help-tip icon-question-sign" href="#ip_addr"></i>
</span>
</td>
</tr>
<tr>
......@@ -64,8 +69,11 @@ $info=Format::htmlchars(($errors && $_POST)?$_POST:$info);
IP Address:
</td>
<td>
<span>
<input type="text" size="30" name="ipaddr" value="<?php echo $info['ipaddr']; ?>">
&nbsp;<span class="error">*&nbsp;<?php echo $errors['ipaddr']; ?></span>
<i class="help-tip icon-question-sign" href="#ip_addr"></i>
</span>
</td>
</tr>
<?php } ?>
......
......@@ -96,10 +96,8 @@ if($_POST){
$page='apikeys.inc.php';
$tip_namespace = 'manage.api_keys';
if($api || ($_REQUEST['a'] && !strcasecmp($_REQUEST['a'],'add'))) {
if($api || ($_REQUEST['a'] && !strcasecmp($_REQUEST['a'],'add')))
$page = 'apikey.inc.php';
$tip_namespace = 'manage.addnew_api';
}
$nav->setTabActive('manage');
$ost->addExtraHeader('<meta name="tip-namespace" content="' . $tip_namespace . '" />',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment