GUI
commented
10 years ago This embeddable signup form is a feature that's implemented, but we might still need to tweak based on your requirements. If this ends up working for you, then I can writeup more formal documentation around this feature for other participating agencies.
Here's a demonstration of how the signup flow currently works on another site: http://jsfiddle.net/nickblah/Vvk7P/4/
Basically, it embeds the exact signup form and flow you see on api.data.gov into your website. It should inherit your page's default styles, but you can customize the look and feel as you see fit. If you want functional changes (like hiding/showing certain fields during signup, or different text or different links on the confirmation page), then let us know, and we'll see what we can do to make it customizable.
To use it on your own page, you'll want to embed that snippet of code from the jsfiddle on your own page. However, you'll want to change the apiKey variable in the source to this one I created just for the Auctions API: 0aYAx2eY37dkfjqsrrZ53SSCkY1yY2kRYGvY27rv So I think this should be the snippet you'd use in its entirety:
<div id="apidatagov_signup">Loading signup form...</div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var apiUmbrellaSignupOptions = {
registrationSource: 'web',
apiKey: '0aYAx2eY37dkfjqsrrZ53SSCkY1yY2kRYGvY27rv'
};
/* * * 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>Let us know if you have any questions or run into any issues with embedding this. I'd also be happy to submit a pull request with this update, but I thought you might want to first play around with it to get a sense of how it works or if there's any changes you'd like to see.
gbinal
kishoregh
@gui - can you share instructions or file a pull request for how we could integrate the api key signup into a page on gsa.github.io/auctions_api?
I'd then recommend adding a sidebar nav item for the api key signup page. That way developers don't leave your microsite when they get a key