Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.6 KB

ORGS_API.md

File metadata and controls

30 lines (23 loc) · 1.6 KB

HackGreenville Orgs API

The Organizations API can be used to build your own custom applications from the structured JSON data representing the HackGreenville organizations.

Interactive API Explorer

Start with the interactive API explorer which:

  • documents the query parameters that allow for filtering the results
  • allows you to use a built-in "Try it out" button to generate API URLs
  • allows you to use a built-in "Send Request" button to execute the API call within the explorer
  • shows sample JSON responses

Limitations, Gotchas, and Contributor Tips

  • We support two API versions, v1 and v0, but we encourage using v1.
  • The production / live website is cached and changes may take up to 4 hours to show due to the cache.
  • Tag IDs are not documented in the API explorer and require manual creation by the HG Labs volunteers. Example: tag ID 1 is for events hosted at OpenWorks Coworking.
  • Please do not hammer the APIs
  • Contact the contributors at HackGreenville Labs via Slack #hg-labs channel with any questions.
  • When viewing API's responses in a web browser, check the "Pretty Print" box in the browser to make it easy to read.

The Code

The code for the Organizations API is primarily located in /app-modules/

  • Controllers: api/src/Http/Controllers/
  • Resources: api/src/Resources/
  • Tests: api/tests/Feature/

Kudos to Past Contributors

  • Thanks to @allella for the initial development on Drupal
  • Thanks to @bogdankharchenko for migrating the Drupal implementation to PHP / Laravel