Skip to content
This repository was archived by the owner on Jan 12, 2018. It is now read-only.

Adding the API key sign up to the documentation #13

Open
LindsayYoung wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding the API key sign up to the documentation #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions src/main/template/main.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,70 @@
<h1 class="info_title">{{info.title}} API Documentation</h1>
<div class="info_description markdown">{{{info.description}}}</div>
<div class="basic-info">

<div id="apidatagov_signup">Loading signup form...</div>
<script type="text/javascript">

var apiUmbrellaSignupOptions = {
registrationSource: 'fec-api',
apiKey: 'LqADfOL61ILN9TrHFJncLATsaq05ScAI70lQdYKJ',
// Provide an example URL you want to show to users after they signup.
// This can be any API endpoint on your server, and you can use the
// special {{api_key}} variable to automatically substitute in the API
// key the user just signed up for.
exampleApiUrl: 'https://api.data.gov/gsa/auctions?api_key={{api_key}}&format=JSON',

// OPTIONAL: Provide extra content to display on the signup confirmation
// page. This will be displayed below the user's API key and the example
// API URL are shown. HTML is allowed. Defaults to ""
signupConfirmationMessage: 'Thank you for signing up for an API key.',

// OPTIONAL: Provide a URL to your own contact page to link to for user
// support. Defaults to "https://api.data.gov/contact/"
// contactUrl: 'https://agency.gov/example',

// OPTIONAL: Set to true to verify the user's e-mail address by only
// sending them their API key via e-mail, and not displaying it on the
// signup confirmation web page. Defaults to false.
// verifyEmail: true,

// OPTIONAL: Set to false to disable sending a welcome e-mail to the
// user after signing up. Defaults to true.
// sendWelcomeEmail: false,

// OPTIONAL: Provide the name of your developer site. This will appear
// in the subject of the welcome e-mail as "Your {{siteName}} API key".
// Defaults to "api.data.gov".
siteName: 'api.open.fec.gov',

// OPTIONAL: Provide a custom sender name for who the welcome email
// appears from. The actual address will be "noreply@api.data.gov", but
// this will change the name of the displayed sender in this fashion:
// "{{emailFromName}} <noreply@api.data.gov>". Defaults to "".
// emailFromName: 'Agency Developer Network',

// OPTIONAL: Provide an extra input field to ask for the user's website.
// Defaults to false.
// websiteInput: true,

// OPTIONAL: Provide an extra checkbox asking the user to agree to terms
// and conditions before signing up. Defaults to false.
// termsCheckbox: true,

// OPTIONAL: If the terms & conditions checkbox is enabled, link to this
// URL for your API's terms & conditions. Defaults to "".
// termsUrl: "https://agency.gov/api-terms/",
};

/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var apiUmbrella = document.createElement('script'); apiUmbrella.type = 'text/javascript'; apiUmbrella.async = true;
apiUmbrella.src = 'https://api.data.gov/static/javascripts/signup_embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(apiUmbrella);
})();
</script>
<noscript>Please enable JavaScript to signup for an <a href="http://api.data.gov/">api.data.gov</a> API key.</noscript>

<table>
<tbody>
<tr>
Expand Down