How to rename "Consumer Key" to "API key" in dev portal

[anton]

Hello,

Our API docs use "apikey" query parameter and I'd like to rename the "Consumer Key" parameter in the developer's app details to match it with the parameter, so making it clearer to the developers what parameter they're supposed to pass.

While we're on this topic, it's also unclear why we need Consumer Secret, it doesn't seem to be used anywhere, and I'd like to hide this field from the developers.

Thanks,

Anton.

[rmishra]

To answer the second part of your question:

Consumer Secrets are required in most workflows when you try to acquire an Access Token . It is not useless. It's like an application's password (if you think of API Key/Consume Key as a username) and must be kept confidential

[DChiesa]

Anton, you're using the Drupal-Based developer portal, is that right?

If so....

There is a template file that displays the list of keys and apps for your developers.

It is normally found in ~portalhome/sites/all/themes/THEME/templates/devconnect

and the filename is devconnect_developer_apps_list.tpl.php

In that file, I have the appropriate logic to display a table of apps and credentials, which looks like this:

Attached is the code that does this.

app-catalog-snip.zip

[anton]

Thanks @Dino, yes it's for a dev portal based on Drupal - https://developer.freightos.com

The thing is that I don't have this template in my source code, and the GUI doesn't look like yours. Instead it looks like this, and here I want to change the word Consumer to API.

Thanks in advance.

[dchiesa1]

Yes, I've got it. I understand. The reason that file does not exist is possibly because you haven't overridden the template.

Your site uses a theme. If your theme is "Apigee Responsive" (The default) or derived from Apigee Responsive (very common, and recommended), then there exists a template as I described that governs how the API keys get displayed. It will be under the "master theme" directory. For example profiles/apigee/themes/apigee_responsive/templates/devconnect/devconnect_developer_apps_list.tpl.php

But you don't want to modify THAT. What you want is to override it. To do that in Drupal you can add a new file in your theme directory, which is going to be something like

sites/all/themes/YOURTHEMENAME/templates/devconnect/devconnect_developer_apps_list.tpl.php

The display I showed you is from a modified template. The reason your display doesn't look like mine is because I've customized my display with a modified template, and you haven't.

If you copy the original file into the appropriate directory for your theme, then modify the copy, to replace Consumer with API (and any other changes you desire) , then you'll see a modified display.

Be sure to clear the drupal cache after making changes, to see the latest updates.

[anton]

@Dino there are two issues, apparently only this file isn't enough.

1) The site layout is broken, there's no header and footer.

2) Check out below the error that I get now in my apps at http://dev-freightosdp.devportal.apigee.io/user/me/apps

[anilsr · Accepted solution]

@Anton+Bar

Please find the right template code,

<?php
/**
 * @file
 * Apigee Responsive theme implementation to display list of developer apps.
 *
 * Available variables inherited from devconnect_developer_apps:
 * $add_app - link to add an app if user has permission, otherwise FALSE.
 * $application_count - number of applications registered to the user
 * $applications - array of arrays, each of which has the following keys:
 *  - app_name
 *  - callback_url
 *  - credential (each member has apiproduct, status, displayName keys)
 *  - delete_url
 *  - created (Unix timestamp)
 *  - new_status (TRUE if app created in last 24 hrs, FALSE otherwise)
 *  - noproducts (TRUE if there are no API Products for this app, else FALSE)
 *  - id (unique JS identifier used in generating modals & links to modals)
 * $user - fully-populated user object (stdClass)
 * $developer_status - TRUE if developer is active, FALSE if inactive.
 * $show_status - bool indicating whether APIProduct status should be shown.
 * $show_analytics - bool indicating whether analytics link should be shown.
 * $singular - label for an app. Usually App or API. First letter is uppercase.
 * $singular_downcase - label for an app, with first letter lowercased unless
 *                      it is an acronym.
 * $plural - label for more than one app. First letter uppercase.
 * $plural_downcase - label for more than one app, downcased as above.
 *
 * Additional variables added via preprocess hook in template.php:
 *
 */


$i = 0;


?>
<?php if (!$developer_status): ?>
  <div class="row alert alert-warning">
    <?php print t('Your developer status is marked as inactive. Even though the credentials below may appear active, you will not be able to use them until an administrator has activated your account.'); ?>
  </div>
<?php endif; ?>
<?php if ($add_app): ?>
  <div class="row">
    <div class="col-sm-12">
      <div class="add-app-button pull-right">
        <?php print $add_app; ?>
      </div>
    </div>
  </div>
<?php endif; ?>


<?php if ($application_count): ?>
  <div class="row">
    <div class="col-sm-12">
      <h2 class="featurette-heading"><?php print t('These are your @apps!', array('@apps' => $plural_downcase)); ?>
        <span class="text-muted"><?php print t('Explore them!'); ?></span>
      </h2>
      <hr>
    </div>
  </div>
  <div class="row">
  <div class="col-sm-12 my-apps-app-keys">
  <?php // more than one application ?>
  <?php foreach ($applications as $app): ?>
    <?php $status = apigee_responsive_app_status($app); ?>
    <div class="panel-group" id="my-apps-accordion">
      <div class="panel panel-default">
        <div class="panel-heading">
          <h4 class="panel-title">
            <div class="truncate">
              <?php if ((bool) $app['new_status']) : ?><span class="badge"><?php echo t("new"); ?></span>  <?php endif; ?>
              <a data-toggle="collapse" data-parent="#my-apps-accordion" href="#my-apps-collapse<?php print $i; ?>"><strong><?php print check_plain($app['app_name']); ?></strong></a>
            </div>
            <div class="status-label">
                <?php print _apigee_responsive_status_label_callback($status, TRUE); ?>
                <?php
                    $expiry = $app['credential']['expires'];
                    $hasExpiration = isset($app['credential']['expires']) && ($expiry != -1);
                    $isExpired = $hasExpiration && (time() > $expiry);
                ?>
                <?php if ($isExpired): ?>
                    <span class="label label-danger pull-right" style="margin-right:10px;">
                        <?php print t('Expired') ?>
                    </span>
                <?php endif; ?>
            </div>
          </h4>
        </div>
        <div id="my-apps-collapse<?php print $i; ?>" class="my-apps-panels panel-collapse collapse">
          <div class="panel-body">
            <ul class="nav nav-pills">
              <li class="active"><a data-toggle="tab" href="#keys<?php print $i; ?>"><?php print t('Keys'); ?></a></li>
    <?php if (!$app['noproducts']) : ?>
              <li><a data-toggle="tab" href="#profile<?php print $i; ?>"><?php print t('Products'); ?></a></li>
      <?php if (isset($app['smartdocs'])) : ?>
              <li><a data-toggle="tab" href="#docs<?php print $i; ?>"><?php print t('Docs'); ?></a></li>
      <?php endif; ?>
    <?php endif; ?>
              <li><a data-toggle="tab" href="#details<?php print $i; ?>"><?php print t('Details'); ?></a></li>
    <?php if ($show_analytics): ?>
              <li><?php print l(t('Analytics'), $app['detail_url']); ?></li>
    <?php endif; ?>
    <?php if (user_access("edit developer apps")): ?>
              <li class="hidden-xs apigee-modal-link-edit"><a href="<?php print base_path() . $app['edit_url']; ?>" data-toggle="modal" data-target="#edit-<?php print $app['id']; ?>"><?php print t('Edit "%n"', array('%n' => $app['app_name'])); ?></a></li>
              <li class="visible-xs apigee-modal-link-edit"><a href="<?php print base_path() . $app['edit_url']; ?>" data-toggle="modal" data-target="#edit-<?php print $app['id']; ?>"><?php print t('Edit'); ?></a></li>
    <?php endif; // edit developer apps ?>
    <?php if (user_access("delete developer apps")): ?>
              <li class="hidden-xs apigee-modal-link-delete"><a href="<?php print base_path() . $app['delete_url']; ?>" data-toggle="modal" data-target="#delete-<?php print $app['id']; ?>"><?php print t('Delete "%n"', array('%n' => $app['app_name'])); ?></a></li>
              <li class="visible-xs apigee-modal-link-delete"><a href="<?php print base_path() . $app['delete_url']; ?>" data-toggle="modal" data-target="#delete-<?php print $app['id']; ?>"><?php print t('Delete'); ?></a></li>
    <?php endif; // delete developer apps ?>
            </ul>
    <?php if (user_access('edit developer apps')): ?>
    <!-- Edit Modal -->
            <div class="modal fade" id="edit-<?php print $app['id']; ?>" tabindex="-1">
              <div class="modal-dialog">
                <div class="modal-content">
                  <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
                    <h4 class="modal-title" id="edit-<?php print $app['id']; ?>-title"><?php print t('Edit @name', array('@name' => $app['app_name'])); ?></h4>
                  </div>
                  <div class="modal-body"></div>
                  <div class="modal-footer">
                    <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
                  </div>
                </div>
              </div>
            </div>
    <?php endif; ?>
    <!-- Delete Modal -->
    <?php if (user_access('delete developer apps')): ?>
            <div class="modal fade" id="delete-<?php print $app['id']; ?>" tabindex="-1">
              <div class="modal-dialog">
                <div class="modal-content">
                  <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
                    <h4 class="modal-title" id="delete-<?php print $app['id']; ?>-title"><?php print t('Delete @name', array('@name' => $app['app_name'])); ?></h4>
                  </div>
                  <div class="modal-body"></div>
                  <div class="modal-footer"></div>
                </div>
              </div>
            </div>
    <?php endif; ?>
            <div class="tab-content" id="myTabContent">
              <div id="keys<?php print $i; ?>" class="tab-pane fade in active">
                <hr>
                <div class="panel panel-default">
                  <div class="panel-heading"><strong><?php print t('@name’s Keys', array('@name' => $app['app_name'])); ?></strong></div>
        <?php if ($app['new_status'] && !$app['noproducts']) : ?>
                  <div class="panel-body">
                    <p><?php print t('Below are keys you can use to access the API products associated with this application <em><span class="text-muted">(@name)</span></em>. The actual keys need to be approved <em>and</em> approved for an <em>API product</em> to be capable of accessing any of the URIs defined in the API product.', array('@name' => $app['app_name'])); ?></p>
                  </div>
        <?php endif; // new_status && !noproducts ?>
                  <div class="table-responsive">
                    <table class="table" style="border:0;">
                      <tbody>
                        <tr>
                          <td class="key"><strong><?php print t('API Key'); ?></strong></td>
                          <td>
                            <span<?php print ($status == 'Revoked' || $status == 'Pending' ? ' class="striked"' : ''); ?>><?php print $app['credential']['consumerKey']; ?></span>
        <?php if ($status == 'Pending'): ?>
                            <hr>
                            <?php print t('Some products associated with this application are in <span class="label label-default">pending</span> status.'); ?>
                            <hr>
                            <ul style="margin:0;padding:0;">
                              <?php foreach ($app['credential']['apiProducts'] as $product): ?>
                                <?php if ($product['status'] == 'pending'): ?>
                                  <li style="margin:0;padding:0;list-style-type:none;"><?php print $product['displayName']; ?></li>
                                <?php endif; ?>
                              <?php endforeach; ?>
                            </ul>
        <?php endif; // status Pending ?>
        <?php if ($status == 'Revoked'): ?>
                            <hr>
                            <?php print t('Some products associated with this application are in <span class="label label-default">revoked</span> status.'); ?>
                            <hr>
                            <ul style="margin:0;padding:0;">
                              <?php foreach ($app['credential']['apiProducts'] as $product): ?>
                                <?php if ($product['status'] == 'revoked'): ?>
                                  <li style="margin:0;padding:0;list-style-type:none;"><?php print $product['displayName']; ?></li>
                                <?php endif; ?>
                              <?php endforeach; ?>
                            </ul>
        <?php endif; // status Revoked ?>
                          </td>
                        </tr>
                        <tr>
                          <td class="key"><strong><?php print t('API Secret'); ?></strong></td>
                          <td>
                            <span<?php print ($status == 'Revoked' || $status == 'Pending' ? ' class="striked"' : ''); ?>><?php print $app['credential']['consumerSecret']; ?></span>
                          </td>
                        </tr>
        <?php if ($status == 'Approved'): ?>
                        <tr>
                          <td class="key"><strong><?php print t('Key Issued'); ?></strong></td>
                          <td><?php print format_date($app['credential']['issued']); ?></td>
                        </tr>
                        <tr>
                          <td class="key">
                            <?php if ($isExpired): ?>
                              <span class="label label-danger"><?php print t('Expired'); ?></span>
                            <?php else: ?>
                                <strong><?php print t('Expires'); ?></strong>
                            <?php endif; ?>
                          </td>
                          <td class="key-expire-date">
                            <?php if ($hasExpiration): ?>
                                <?php if ($isExpired): ?>
                                    <span class="key-expire-date-value is-expired"><?php print format_date($expiry); ?></span>
                                <?php else: ?>
                                    <span class="key-expire-date-value"><?php print format_date($expiry); ?></span>
                                <?php endif; ?>
                            <?php else: ?>
                              <span class="key-expire-date-value"><?php print t('Never'); ?></span>
                            <?php endif; ?>
                          </td>
                        </tr>
        <?php endif; ?>
                      </tbody>
                    </table>
                  </div><!-- /table-responsive -->
                </div><!-- /panel -->
              </div><!-- /keys<?php print $i; ?> -->
        <?php if (!$app['noproducts']): ?>
              <div id="profile<?php print $i; ?>" class="tab-pane fade">
                <hr>
        <?php foreach ($app['credential']['apiProducts'] as $product): ?>
                <div class="panel panel-default">
                  <div class="panel-heading"><?php print t('API Product:'); ?> <strong><?php print check_plain($product['displayName']); ?></strong></div>
                  <div class="table-responsive">
                    <table class="table" style="border:0;">
                      <tbody>
                        <tr>
                          <td class="key"><strong><?php print t('Status'); ?></strong></td>
                          <td><?php print _apigee_responsive_status_label_callback($status); ?></td>
                        </tr>
                      </tbody>
                    </table>
                  </div>
                </div>
                <br>
        <?php endforeach; // apiProducts ?>
              </div>
        <?php if (isset($app['smartdocs'])) : ?>
              <div id="docs<?php print $i; ?>" class="tab-pane fade">
                <hr>
                <div class="panel-heading"><?php print t('Quick Reference:'); ?></div>
          <?php foreach ($app['credential']['apiProducts'] as $product): ?>
            <?php foreach ($app['smartdocs'] as $docs): ?>
              <?php foreach ($docs as $link): ?>
                  <div class="panel panel-default">
                    <div class="panel-heading">
                      <strong><?php print check_plain($product['displayName']); ?></strong> <?php print t('Documentation:'); ?> <?php print $link; ?></div>
                  </div>
                  <br>
              <?php endforeach; // link ?>
            <?php endforeach; // docs ?>
          <?php endforeach; // product ?>
                </div>
      <?php endif; // smartdocs ?>
    <?php endif; // !noproducts ?>
                <div id="details<?php print $i; ?>" class="tab-pane fade">
                <hr>
                  <div class="panel panel-default">
                    <div class="panel-heading"><strong><?php print t('@name’s Details', array('@name' => $app['app_name'])); ?></strong></div>
                    <div class="table-responsive">
                      <table class="table" style="border:0;">
                        <tbody>
                          <tr>
                            <td class="key"><strong><?php print t('Application Name'); ?></strong></td>
                            <td><?php print check_plain($app['app_name']); ?></td>
                          </tr>
    <?php if (!$app['noproducts']): ?>
                          <tr>
                            <td class="key"><strong><?php print t('API Products'); ?></strong></td>
                            <td>
                              <ul style="margin:0;padding:0;">
                                <?php foreach ($app['credential']['apiProducts'] as $product): ?>
                                  <li style="margin:0;padding:0;list-style-type:none;"><?php print check_plain($product['displayName']); ?></li>
                                <?php endforeach; ?>
                              </ul>
                            </td>
                          </tr>
    <?php endif; // !noproducts ?>
    <?php if (!empty($app['attributes'])): ?>
      <?php foreach ($app['attributes'] as $name => $attr): ?>
                          <tr>
                            <td class="key"><strong><?php print check_plain($name); ?></strong></td>
                            <td><?php print check_plain($attr); ?></td>
                          </tr>
      <?php endforeach; // attributes ?>
    <?php endif; // attributes ?>
    <?php if (!empty($app['callback_url'])): ?>
                          <tr>
                            <td class="key"><strong><?php print t('Callback URL'); ?></strong></td>
                            <td><?php print $app['callback_url']; ?></td>
                          </tr>
    <?php endif; // callback_url ?>
                        </tbody>
                      </table>
                    </div>
                  </div>
                </div>
                <div id="analytics<?php print $i; ?>" class="tab-pane fade">
                  <hr>
                  <?php print render($app['analytics_filter_form']); ?>
                </div>
              </div>
            </div>
          </div>
        </div>
        <br>
      <?php $i++;
        endforeach; // applications ?>
      </div>
    </div>
  </div>
<?php else : ?>
  <?php // no apps ?>
  <div class="row">
    <div class="col-sm-12">
      <h2 class="featurette-heading"><?php print t('Looks like you don’t have any  @apps.', array('@apps' => $plural_downcase)); ?>
        <span class="text-muted"><?php print t('Get started by adding one.'); ?></span>
      </h2>
    </div>
  </div>
<?php endif; // application_count ?>

[anton]

Thanks @Anil Sagar, this did the trick!