Browse files

Rename to Basecamp

  • Loading branch information...
1 parent 698d36b commit 40c4f64e3f3a77fcf19a452aa2eb7085aacd8288 @qrush qrush committed Feb 5, 2014
Showing with 28 additions and 39 deletions.
  1. +11 −22 README.md
  2. +13 −13 sections/authentication.md
  3. +4 −4 sections/brand_guidelines.md
View
33 README.md
@@ -1,7 +1,7 @@
-37signals APIs
-==============
+Basecamp APIs
+=============
-Looking to integrate with a 37signals product? We've got everything you need here. From sample code to detailed API documentation, you'll be up and running in no time.
+Looking to integrate with a Basecamp product? We've got everything you need here. From sample code to detailed API documentation, you'll be up and running in no time.
Where do I start?
@@ -21,42 +21,31 @@ API Documentation
Need to look up the API documentation for a product? There's a repo for each:
-* [Basecamp API](https://github.com/37signals/bcx-api)
-* [Basecamp Classic API](https://github.com/37signals/basecamp-classic-api)
-* [Highrise API](https://github.com/37signals/highrise-api)
-* [Campfire API](https://github.com/37signals/campfire-api)
-* [Backpack API](https://github.com/37signals/backpack-api)
-* [System Status API](http://status.37signals.com/api)
-
+* [Basecamp API](https://github.com/basecamp/bcx-api)
+* [Basecamp Classic API](https://github.com/basecamp/basecamp-classic-api)
Authentication
--------------
Logging your users into our products is supported through OAuth 2. Several apps support login via API tokens and HTTP Basic Authentication as well.
-We have a [detailed guide](https://github.com/37signals/api/blob/master/sections/authentication.md) for authenticating your users with our apps.
+We have a [detailed guide](https://github.com/basecamp/api/blob/master/sections/authentication.md) for authenticating your users with our apps.
Brand Guidelines
----------------
-Have questions on how to name and publicize your app? Our [brand guidelines](https://github.com/37signals/api/blob/master/sections/brand_guidelines.md) have some basic answers for you. If you have a more detailed question, just [open up a support ticket](http://help.37signals.com/tickets/new) and we'll sort it out!
-
-
-Official logos
---------------
+Have questions on how to name and publicize your app? Our [brand guidelines](https://github.com/basecamp/api/blob/master/sections/brand_guidelines.md) have some basic answers for you. If you have a more detailed question, just [open up a support ticket](http://help.basecamp.com/tickets/new) and we'll sort it out!
-This repo contains official high quality EPS logos for each product, which we encourage use of to promote your app!
-* [Basecamp official logo](https://github.com/37signals/api/tree/master/logos/basecamp.eps?raw=true)
-* [Highrise official logo](https://github.com/37signals/api/tree/master/logos/highrise.eps?raw=true)
-* [Campfire official logo](https://github.com/37signals/api/tree/master/logos/campfire.eps?raw=true)
-* [Backpack official logo](https://github.com/37signals/api/tree/master/logos/backpack.eps?raw=true)
+Official logo
+-------------
+Need our logo for your marketing page? You can download the [Basecamp official logo](https://github.com/basecamp/api/tree/master/logos/basecamp.eps?raw=true) in the repo.
Help us make it better
----------------------
-Please tell us how we can make the APIs better. If you have a specific feature request or if you found a bug, please [open a support ticket](http://help.37signals.com/tickets/new). Also, feel free to fork these docs and send a pull request with improvements!
+Please tell us how we can make the APIs better. If you have a specific feature request or if you found a bug, please [open a support ticket](http://help.basecamp.com/tickets/new). Also, feel free to fork these docs and send a pull request with improvements!
To talk with us and other developers about the API, subscribe to the [37signals-api mailing list](http://groups.google.com/group/37signals-api).
View
26 sections/authentication.md
@@ -1,9 +1,9 @@
-37signals API Authentication
-============================
+Basecamp API Authentication
+===========================
> Speak, friend, and enter.
-All 37signals' products API requests can be authenticated by passing along an OAuth 2 token. API keys are supported as well for some apps.
+All Basecamp' products API requests can be authenticated by passing along an OAuth 2 token. API keys are supported as well for some apps.
Basic Auth (new Basecamp only)
------------------------------
@@ -60,19 +60,19 @@ The typical flow for a web app:
https://launchpad.37signals.com/authorization/new?type=web_server&client_id=your-client-id&redirect_uri=your-redirect-uri
-2. We authenticate their 37signals ID and ask whether it's ok to give access to your app. [Here's an example of what this screen looks like](https://launchpad.37signals.com/authorization/new?type=web_server&client_id=0bf18204f5a28003bf7b9abb7e1db5e649d86ef4&redirect_uri=moist%3A%2F%2Foauth)
+2. We authenticate their Basecamp ID and ask whether it's ok to give access to your app. [Here's an example of what this screen looks like](https://launchpad.37signals.com/authorization/new?type=web_server&client_id=0bf18204f5a28003bf7b9abb7e1db5e649d86ef4&redirect_uri=moist%3A%2F%2Foauth)
3. We redirect the user back to your app with a time-limited verification code.
4. Your app makes a backchannel request to trade the verification code for an access token. We authenticate your app and issue an access token:
POST https://launchpad.37signals.com/authorization/token?type=web_server&client_id=your-client-id&redirect_uri=your-redirect-uri&client_secret=your-client-secret&code=verification-code
-5. Your app uses the token to authorize API requests to any of the 37signals ID's accounts. Set the Authorization request header:
+5. Your app uses the token to authorize API requests to any of the Basecamp ID's accounts. Set the Authorization request header:
Authorization: Bearer YOUR_OAUTH_TOKEN
-6. To get info about the 37signals ID you authorized and the accounts you have access to, make an authorized request to `https://launchpad.37signals.com/authorization.json` (or `/authorization.xml`). (See
+6. To get info about the Basecamp ID you authorized and the accounts you have access to, make an authorized request to `https://launchpad.37signals.com/authorization.json` (or `/authorization.xml`). (See
Implementation notes:
@@ -103,7 +103,7 @@ This endpoint should be first request made after you've obtained a user's author
"identity": {
"id": 9999999,
"name": "Jason Fried",
- "email_address": "jason@37signals.com",
+ "email_address": "jason@basecamp.com",
},
"accounts": [
{
@@ -132,12 +132,12 @@ This endpoint should be first request made after you've obtained a user's author
Who am I?
---------
-So you've picked the product, have the `href` to request to, and now what? Depending on what your API integration needs, you may need to know who the current user is within that product. For example, if you were working with the [Basecamp API](https://github.com/37signals/bcx-api) this is how you would obtain the `id` field to [submit a todo](https://github.com/37signals/bcx-api/blob/master/sections/todos.md#create-todo) assigned to the current user.
+So you've picked the product, have the `href` to request to, and now what? Depending on what your API integration needs, you may need to know who the current user is within that product. For example, if you were working with the [Basecamp API](https://github.com/Basecamp/bcx-api) this is how you would obtain the `id` field to [submit a todo](https://github.com/Basecamp/bcx-api/blob/master/sections/todos.md#create-todo) assigned to the current user.
Here's links to the endpoints in our products that you'll need to hit:
-* [Basecamp: Get person](https://github.com/37signals/bcx-api/blob/master/sections/people.md#get-person)
-* [Basecamp Classic: Current person](https://github.com/37signals/basecamp-classic-api/blob/master/sections/people.md#current-person)
-* [Highrise: Get myself](https://github.com/37signals/highrise-api/blob/master/sections/users.md#get-myself)
-* [Campfire: Get self](https://github.com/37signals/campfire-api/blob/master/sections/users.md#get-self)
-* [Backpack: Current user](https://github.com/37signals/backpack-api/blob/master/sections/users.md#current-user)
+* [Basecamp: Get person](https://github.com/basecamp/bcx-api/blob/master/sections/people.md#get-person)
+* [Basecamp Classic: Current person](https://github.com/basecamp/basecamp-classic-api/blob/master/sections/people.md#current-person)
+* [Highrise: Get myself](https://github.com/basecamp/highrise-api/blob/master/sections/users.md#get-myself)
+* [Campfire: Get self](https://github.com/basecamp/campfire-api/blob/master/sections/users.md#get-self)
+* [Backpack: Current user](https://github.com/basecamp/backpack-api/blob/master/sections/users.md#current-user)
View
8 sections/brand_guidelines.md
@@ -17,7 +17,7 @@ Naming your app
* Use words that are related to our apps — like “Base” or “Camp”.
* Use language to suggest that your app is official or endorsed by us.
-![Don't name your app this](https://github.com/37signals/api/blob/master/sections/img-baseapp.png?raw=true)
+![Don't name your app this](https://github.com/basecamp/api/blob/master/sections/img-baseapp.png?raw=true)
Creating your app’s logo
@@ -33,7 +33,7 @@ Creating your app’s logo
* Use visual elements from the Basecamp, Highrise, Backpack, or Campfire logos.
* Use the snowglobe shape.
-![Don't paste Windows XP icons inside of our snowglobes, please.](https://github.com/37signals/api/blob/master/sections/img-snowglobe.png?raw=true)
+![Don't paste Windows XP icons inside of our snowglobes, please.](https://github.com/basecamp/api/blob/master/sections/img-snowglobe.png?raw=true)
Marketing your app
@@ -42,12 +42,12 @@ Marketing your app
**Do**
* Say that your app integrates or works with Basecamp, Highrise, Backpack, or Campfire.
-* Download official [logos](https://github.com/37signals/api/tree/master/logos) for use on your site.
+* Download official [logos](https://github.com/basecamp/api/tree/master/logos) for use on your site.
* Link to our product websites for your customers to learn more.
**Don't**
* Use language to suggest that your app is official or endorsed by us.
* Manipulate or recreate our product logos.
-![Make your app unique!](https://github.com/37signals/api/blob/master/sections/img-bcbastard.png?raw=true)
+![Make your app unique!](https://github.com/basecamp/api/blob/master/sections/img-bcbastard.png?raw=true)

0 comments on commit 40c4f64

Please sign in to comment.