Skip to content
Adam Goldman edited this page Oct 27, 2015 · 11 revisions

Base url: api.backfeed.cc

All calls require to pass satellizer_token in the header (add link to how to obtain this token) Through the satellizer token the server identifies the user and the relevant organization


Create a new organisation

  • url: /organization
  • Type: POST
  • Response:
  • params:
Name Type Example Description
tokenCode String "BTC" Three letters representing the tokens (like BTC for BitCoin)
tokenName String "Awesomeness coins"
founders Array of objects [{ id: "U06PXNST0", percentage: 100 }] The contributors to the founding of the project
initialTokens Integer 1000000 The amount of tokens to be distributed between the founders. This is just a reference for future evaluations and has no meaning on it's own
passingResponsibilityRate Number 40 link for more information here
similarEvaluationRate Number 32 link for more info here

Get all organizations

  • url: /organization/all
  • Type: GET
  • Response: Array of Objects with each containing:
Name Type Example Description
id Integer 5
name String "the greatest project of all times"
tokenName String "Greatness Coin"
tokenCode String "GRC"

Get organization

  • url: /organization/:organizationId
  • Type: GET
  • Response: {}
  • params:
Name Type Example Description

Create Contribution

  • url: /contribution
  • Type: POST
  • Response: {}
  • params:
Name Type Example Description
Title String "Fix the hallway door"
Description String "The hallway door handle falls down every once in a while. I've tightened the screws and oiled the hinges
contributors Array of Objects [{ id: "U06PXNST0", percentage: 100 }]
orgId? Integer 12

Get Contribution

  • url: /contribution/:contributionId
  • Type: GET
  • Response: {}
  • params:
Name Type Example Description

Evaluate Contribution

  • url: /bids
  • Type: POST
  • Response: {}
  • params:
Name Type Example Description
contributionId Integer 3
evaluation Integer 25

Create Milestone

  • url: /milestone
  • Type: POST
  • Response: {}
  • params:
Name Type Example Description
Title string "50% of forestation done"
Description String "We covered the entire south side, only the north is left. Oxygen for everyone!"
evaluatingProject (Should be evaluatingOrgId) String (Should be Integer) "4"

Get Milestone

  • url: /milestone/:milestoneId

  • Type: GET

  • Response: { id: 9, date: '', description: '', title: '', startDate: '', endDate: '', creatorId: 1, evaluatingOrgId: 3, orgId: 2, totalValue: 50, contributions: [{ id: 1, contributors: [{ imgUrl: '', id: 9 }], date: '', description: '', title: '', valuation: 20
    }], contributors: [{ id: 1, imgUrl: '', name: '', percentage: 20, fullName: '' }] }

  • params:

Name Type Example Description

Get Current Milestone / On Going Work

  • url: /organization/currentStatus/:orgId
  • Type: GET
  • Response: same as get milestone
  • params:
Name Type Example Description

Evaluate Milestone

  • url: /milestoneBids
  • Type: POST
  • Response: {}
  • params:
Name Type Example Description
milestoneId Integer 4
evaluation: Integer: 6

Create User

  • url: /
  • Type: POST
  • Response: {}
  • params:
Name Type Example Description
name String adam
fullName String Adam Goldman
imgUrl String http://abra.kadabra.com/alakazamMyAwesomePic.jpg

Create Users

  • url: /
  • Type: POST
  • Response: {}
  • params: Array of create user params (see above)

Delete User

  • url: /
  • Type: DELETE
  • Response: {}
  • params:
Name Type Example Description
userId Integer 4

Delete Users

  • url: /
  • Type: DELETE
  • Response: {}
  • params: Array of delete user params (see above)

Get Current User

  • url: /api/me
  • Type: GET
  • Response:
Name Type Example Description
name String "adam"
fullName String "Adam Goldman"
imgUrl String "https://secure.gravatar.com/avatar/eb26f94528ca07970f54a7e1b65163b6.jpg?s=48&d=https%3A%2F%2Fslack.global.ssl.fastly.net%2F66f9%2Fimg%2Favatars%2Fava_0018-48.png"
id Integer 2
  • params:

Get All User's Projects and Contributions

  • url: /member/status/:userId
  • Type: GET
  • Response:
Name Type Example Description
contributions Array of Objects [{ date: "2015-10-26", currentValuation: 5, id: 70, myWeight: 0, reputationDelta: 4, title: "test1", userId: 2}]
projects Array of Objects [{ id: 4, name: "Windmill" }]
  • params:

Get a User's Project

  • url: /member/status/:userId/:projectId
  • Type: GET
  • Response:
Name Type Example Description
tokenCode String "ATC"
tokenName String "Adam test coins"
contributions Array of Objects Same as previous
reputation Integer 1003260.0
reputationPercentage Integer 32
tokens Integer 34
  • params: