18F / api-program

A complete agency API program.
Creative Commons Zero v1.0 Universal
12 stars 9 forks source link

expand agency manual material #66

Open gbinal opened 8 years ago

gbinal commented 8 years ago

Some initial material -

Using The API

How to Set Up the API

  1. Pick a base url for your API program, such as api.agency.gov.
  2. CNAME it to api.data.gov. ...

How to Add a Dataset

...

How to Edit a Dataset

...

How to Remove a Dataset

...

How to View the API Analytics

...

How to Manage access to the API

...

How to Manage access to the API analytics

...

Developer Hub

How to Initially Set Up the Developer Hub

...

Decide on sections for the site...

How to Edit the Developer Hub

...

How to Add New API Documentation

...

gbinal commented 8 years ago
gbinal commented 8 years ago

edit configuration settings of api.data.gov

How to manage developer access to the API

How to manage access to the API analytics

gbinal commented 8 years ago
gbinal commented 8 years ago

other cloud.gov common tasks (maybe make a whole section for itself) check cloud.gov status - https://cloudgov.statuspage.io/ check api.data.gov status?

gbinal commented 8 years ago
gbinal commented 8 years ago

https://cloudgov.statuspage.io/

gbinal commented 8 years ago

To get s3 credentials - cf env name-of-app it dumps a bunch of json - what you want is under ‘s3’[‘credentials’][‘access_key_id’], [‘bucket’], and [‘secret_access_key’]

gbinal commented 8 years ago
gbinal commented 8 years ago

give example of dogfooding - https://github.com/gbinal/api-mashup