Permalink
Browse files

Become Basecamp

  • Loading branch information...
1 parent ece9428 commit a7dbac394823a79a559079de86f40773abd786fc @qrush qrush committed Feb 6, 2014
Showing with 40 additions and 42 deletions.
  1. +17 −19 README.md
  2. +3 −3 sections/accesses.md
  3. +4 −4 sections/attachments.md
  4. +2 −2 sections/authentication.md
  5. +3 −3 sections/comments.md
  6. +4 −4 sections/messages.md
  7. +4 −4 sections/people.md
  8. +1 −1 sections/todos.md
  9. +2 −2 sections/uploads.md
View
@@ -1,7 +1,7 @@
The new Basecamp API
====================
-The all-new Basecamp has an all-new API. It is not compatible with the [Basecamp Classic API](http://developer.37signals.com/basecamp/). All integrations will have to be updated to use the new API. The core ingredients are still the same, though. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.
+The all-new Basecamp has an all-new API. It is not compatible with the [Basecamp Classic API](https://github.com/basecamp/basecamp-classic-api). All integrations will have to be updated to use the new API. The core ingredients are still the same, though. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.
Making a request
@@ -35,7 +35,7 @@ If you're making a private integration with Basecamp for your own purposes, you
If you're making a public integration with Basecamp for others to enjoy, you must use OAuth 2. This allows users to authorize your application to use Basecamp on their behalf without having to copy/paste API tokens or touch sensitive login info.
-Read the [authentication guide](https://github.com/37signals/api/blob/master/sections/authentication.md) to get started.
+Read the [authentication guide](https://github.com/basecamp/api/blob/master/sections/authentication.md) to get started.
Identify your app
@@ -78,22 +78,20 @@ You can perform up to 500 requests per 10 second period from the same IP address
API ready for use
-----------------
-* [Projects](https://github.com/37signals/bcx-api/blob/master/sections/projects.md)
-* [People](https://github.com/37signals/bcx-api/blob/master/sections/people.md)
-* [Accesses](https://github.com/37signals/bcx-api/blob/master/sections/accesses.md)
-* [Events](https://github.com/37signals/bcx-api/blob/master/sections/events.md)
-* [Topics](https://github.com/37signals/bcx-api/blob/master/sections/topics.md)
-* [Messages](https://github.com/37signals/bcx-api/blob/master/sections/messages.md)
-* [Comments](https://github.com/37signals/bcx-api/blob/master/sections/comments.md)
-* [Todo lists](https://github.com/37signals/bcx-api/blob/master/sections/todolists.md)
-* [Todos](https://github.com/37signals/bcx-api/blob/master/sections/todos.md)
-* [Documents](https://github.com/37signals/bcx-api/blob/master/sections/documents.md)
-* [Attachments](https://github.com/37signals/bcx-api/blob/master/sections/attachments.md)
-* [Uploads](https://github.com/37signals/bcx-api/blob/master/sections/uploads.md)
-* [Calendars](https://github.com/37signals/bcx-api/blob/master/sections/calendars.md)
-* [Calendar events](https://github.com/37signals/bcx-api/blob/master/sections/calendar_events.md)
-
-
+* [Projects](https://github.com/basecamp/bcx-api/blob/master/sections/projects.md)
+* [People](https://github.com/basecamp/bcx-api/blob/master/sections/people.md)
+* [Accesses](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md)
+* [Events](https://github.com/basecamp/bcx-api/blob/master/sections/events.md)
+* [Topics](https://github.com/basecamp/bcx-api/blob/master/sections/topics.md)
+* [Messages](https://github.com/basecamp/bcx-api/blob/master/sections/messages.md)
+* [Comments](https://github.com/basecamp/bcx-api/blob/master/sections/comments.md)
+* [Todo lists](https://github.com/basecamp/bcx-api/blob/master/sections/todolists.md)
+* [Todos](https://github.com/basecamp/bcx-api/blob/master/sections/todos.md)
+* [Documents](https://github.com/basecamp/bcx-api/blob/master/sections/documents.md)
+* [Attachments](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md)
+* [Uploads](https://github.com/basecamp/bcx-api/blob/master/sections/uploads.md)
+* [Calendars](https://github.com/basecamp/bcx-api/blob/master/sections/calendars.md)
+* [Calendar events](https://github.com/basecamp/bcx-api/blob/master/sections/calendar_events.md)
API libraries
-------------
@@ -105,4 +103,4 @@ Help us make it better
Please tell us how we can make the API better. If you have a specific feature request or if you found a bug, please use GitHub issues. 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).
+To talk with us and other developers about the API, [post a question on StackOverflow](http://stackoverflow.com/questions/ask) tagged `basecamp` or [open a support ticket](http://help.basecamp.com/tickets/new).
View
@@ -12,14 +12,14 @@ Get accesses
{
"id": 149087659,
"name": "Jason Fried",
- "email_address": "jason@37signals.com",
+ "email_address": "jason@basecamp.com",
"updated_at": "2012-03-22T16:56:48-05:00",
"url": "https://basecamp.com/999999999/api/v1/people/149087659-jason-fried.json"
},
{
"id": 1071630348,
"name": "Jeremy Kemper",
- "email_address": "jeremy@37signals.com",
+ "email_address": "jeremy@basecamp.com",
"updated_at": "2012-03-22T16:56:48-05:00",
"url": "https://basecamp.com/999999999/api/v1/people/1071630348-jeremy-kemper.json"
}
@@ -39,7 +39,7 @@ Grant access
}
```
-You can get the ids of existing people on the account from the [people API](https://github.com/37signals/bcx-api/blob/master/sections/people.md).
+You can get the ids of existing people on the account from the [people API](https://github.com/basecamp/bcx-api/blob/master/sections/people.md).
This will return `204 No Content` if the access was granted successfully. If the authenticated user does not have access to this project, `404 Not Found` will be returned.
View
@@ -5,9 +5,9 @@ Submitting files to Basecamp is a two step process:
1. Create the attachment, receive a token verifying the upload was successful ("Create attachment" endpoint)
2. Attach the file to a comment, message, or upload. See the following endpoints for attaching:
- * [Create uploads](https://github.com/37signals/bcx-api/blob/master/sections/uploads.md)
- * [Create comments](https://github.com/37signals/bcx-api/blob/master/sections/comments.md)
- * [Create messages](https://github.com/37signals/bcx-api/blob/master/sections/messages.md)
+ * [Create uploads](https://github.com/basecamp/bcx-api/blob/master/sections/uploads.md)
+ * [Create comments](https://github.com/basecamp/bcx-api/blob/master/sections/comments.md)
+ * [Create messages](https://github.com/basecamp/bcx-api/blob/master/sections/messages.md)
Create attachment
-----------------
@@ -31,7 +31,7 @@ With `curl`, here's an example:
curl --data-binary @logo.png \
-u user:pass \
-H 'Content-Type: image/png' \
- -H 'User-Agent: Rapp (david@37signals.com)' \
+ -H 'User-Agent: Rapp (david@basecamp.com)' \
https://basecamp.com/999999999/api/v1/attachments.json
```
@@ -1,6 +1,6 @@
Authentication Guide Moved
==========================
-The authentication guide for the all new Basecamp, along with other 37signals products, is now here:
+The authentication guide for the all new Basecamp, along with other Basecamp products, is now here:
-https://github.com/37signals/api/blob/master/sections/authentication.md
+https://github.com/basecamp/api/blob/master/sections/authentication.md
View
@@ -7,7 +7,7 @@ Comments
Get comments
------------
-Comments are included on the [topics](https://github.com/37signals/bcx-api/blob/master/sections/topics.md) directly. So to see all comments for a message, you'd just GET that message and they're included and look like this:
+Comments are included on the [topics](https://github.com/basecamp/bcx-api/blob/master/sections/topics.md) directly. So to see all comments for a message, you'd just GET that message and they're included and look like this:
```json
{
@@ -46,7 +46,7 @@ Comments are included on the [topics](https://github.com/37signals/bcx-api/blob/
Create comment
--------------
-* `POST /projects/1/<section>/1/comments.json` will create a new comment from the parameters passed for the commentable described via <section>/<id> -- for example /projects/1/messages/1/comments.json or /projects/1/todos/1/comments.json. The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/37signals/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
+* `POST /projects/1/<section>/1/comments.json` will create a new comment from the parameters passed for the commentable described via <section>/<id> -- for example /projects/1/messages/1/comments.json or /projects/1/todos/1/comments.json. The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
```json
{
@@ -75,7 +75,7 @@ This will return `201 Created`, with a representation of the comment just create
### Attaching files
Attaching files to a comment requires both the token and the name of the attachment. The
-token is returned from the [Create attachments](https://github.com/37signals/bcx-api/blob/master/sections/attachments.md)
+token is returned from the [Create attachments](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md)
endpoint, which you must hit first before creating an upload.
The `name` parameter *must* be a valid filename with an extension. Multiple
View
@@ -7,7 +7,7 @@ Messages
Get messages
------------
-Messages are listed alongside all the other [topics](https://github.com/37signals/bcx-api/blob/master/sections/topics.md), so there is no individual index for them.
+Messages are listed alongside all the other [topics](https://github.com/basecamp/bcx-api/blob/master/sections/topics.md), so there is no individual index for them.
Get message
@@ -57,7 +57,7 @@ Get message
Create message
--------------
-* `POST /projects/1/messages.json` will create a new message from the parameters passed. The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/37signals/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
+* `POST /projects/1/messages.json` will create a new message from the parameters passed. The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
```json
{
@@ -67,12 +67,12 @@ Create message
}
```
-This will return `201 Created`, with the location of the new project in the `Location` header along with the current JSON representation of the message if the creation was a success. See the [Get message](https://github.com/37signals/bcx-api/blob/master/sections/messages.md#get-message) endpoint for more info.
+This will return `201 Created`, with the location of the new project in the `Location` header along with the current JSON representation of the message if the creation was a success. See the [Get message](https://github.com/basecamp/bcx-api/blob/master/sections/messages.md#get-message) endpoint for more info.
### Attaching files
Attaching files to a message requires both the token and the name of the attachment. The
-token is returned from the [Create attachments](https://github.com/37signals/bcx-api/blob/master/sections/attachments.md)
+token is returned from the [Create attachments](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md)
endpoint, which you must hit first before creating an upload.
The `name` parameter *must* be a valid filename with an extension. Multiple
View
@@ -15,7 +15,7 @@ Get people
"id": 149087659,
"identity_id": 982871737,
"name": "Jason Fried",
- "email_address": "jason@37signals.com",
+ "email_address": "jason@basecamp.com",
"admin": true,
"avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/avatar.96.gif",
"created_at": "2012-03-22T16:56:48-05:00",
@@ -26,7 +26,7 @@ Get people
"id": 1071630348,
"identity_id": 827377171,
"name": "Jeremy Kemper",
- "email_address": "jeremy@37signals.com",
+ "email_address": "jeremy@basecamp.com",
"admin": true,
"avatar_url": "https://asset0.37img.com/global/e68cafa694e8f22203eb36f13dccfefa9ac0acb2/avatar.96.gif",
"created_at": "2012-03-22T16:56:48-05:00",
@@ -47,7 +47,7 @@ Get person
"id": 149087659,
"identity_id": 982871737,
"name": "Jason Fried",
- "email_address": "jason@37signals.com",
+ "email_address": "jason@basecamp.com",
"admin": true,
"avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/avatar.96.gif?r=3",
"created_at": "2012-03-22T16:56:51-05:00",
@@ -69,7 +69,7 @@ Get person
Create person
-------------
-New people can be invited directly to projects via the [accesses API](https://github.com/37signals/bcx-api/blob/master/sections/accesses.md).
+New people can be invited directly to projects via the [accesses API](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md).
Delete person
View
@@ -4,7 +4,7 @@ Todos
Get todos
---------
-To get an index of all todos on a list, see [todolists](https://github.com/37signals/bcx-api/blob/master/sections/todolists.md).
+To get an index of all todos on a list, see [todolists](https://github.com/basecamp/bcx-api/blob/master/sections/todolists.md).
Get todo
View
@@ -12,13 +12,13 @@ Create uploads
This endpoint will return a `201 Created` if successful, with the URL to the new upload in the `Location` header along with the current JSON representation of the upload. See the **Get upload** for more info.
Attaching files requires both the token and the name of the attachment. The
-token is returned from the [Create attachments](https://github.com/37signals/bcx-api/blob/master/sections/attachments.md)
+token is returned from the [Create attachments](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md)
endpoint, which you must hit first before creating an upload.
The `name` parameter *must* be a valid filename with an extension. Only one
attachment is allowed.
-The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/37signals/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
+The subscribers array is an optional list of people IDs that you want to notify about this comment (see [Get accesses](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md) on how to get the people IDs for a given project).
```json
{

0 comments on commit a7dbac3

Please sign in to comment.