Skip to content

Getting Started

Hillary Fraley edited this page Jun 13, 2016 · 6 revisions

Welcome! Let's get started with Surf Report.

========== 1. Sign up for an Account ========== Go to https://market.mashape.com/ and click the Sign Up button to sign up for an account.

========== 2. Get API Keys ========== You need an API key to use Surf Report. Go to http://docs.mashape.com//api-keys to learn how to get your API key.

We use API keys to:

  • Authenticate calls to Surf Report to registered users only
  • Track who makes Surf Report requests.
  • Track how often people are using Surf Report.

NOTE: Keep your API keys a secret. Do not share your API keys on GitHub or any other public space.

========== 3. Make a Request ========== The root domain for making requests is https://simple-weather.p.mashape.com/surfreport.

========== 4. Review Available Endpoints ========== The available endpoint is /surfreport/{beachId}.

{beachID} is the ID for the specified beach. An up-to-date list of available beaches is at http://example.com/surfreport/beaches_available.